For making your life easy while using Competera, we provide direct data streaming. Please follow instructions for generating an API call. This method of data streaming is a perfect solution for ERP integrations or further data parsing.
Locating Competera API docs
You may check out the detailed API documentation in the Help section of the dashboard. Log in to your dashboard, locate Questionmark on the left bottom screen side“API docs” or by following direct link:
In order to start creating an API call, mandatory data have to be acquired:
- API key
- Company identifier (ID)
- User name (e-mail)
Acquiring an API Key
To find your project API key you have to login to your Competera dashboard. API key is located in user profile settings. Please follow the print screen instructions.
Identifying your Company unique ID
Please note that almost all API calls require the Company Identifier (ID). You can find your company ID right in the browser command line. Please see the print screen instructions.
Creating a basic API call
For every API call you make, you'll need to apply the API key, user name and company id. Keep the API key in secret! It should be guarded just as your regular account password.
Basic url for API call:
Setting specific report:
Setting file format and quantity limits (json/excel):
- https://dashboard.competera.net/api/v1/campaigns/campaign_id/reports/comparison_by_products/?format=json&[email protected]&api_key=c2a1e8722fdr334f776ae000f123456425da1b6f1&limit=100
Setting user access and API key:
- https://dashboard.competera.net/api/v1/campaigns/campaign_id/reports/comparison_by_products/?format=json&[email protected]&api_key=c2a1e8722fdr334f776ae000f123456425da1b6f1&limit=0
If successful, this method returns a JSON structure, as it is shown below.
JSON structure for reviewing your products
JSON structure for reviewing competitors info
Applying various filters to an API call
You may see the list of all available filters in the API docs. However, it is possible to add to an API string such filter as: availability, targets_availability, promo, price_ratio, etc.
If you have any upcoming issues please refer to [email protected]