include_once __DIR__ . '/autoload.php';
use SemstormApi\Semstorm;
use SemstormApi\Monitoring\MonitoringCampaign;
Semstorm::init( __ACCESS_TOKEN__ );
$monitoringCampaign = new MonitoringCampaign();

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign [POST]

Description:
Creates new campaign.

Error:
Request: "domain", or "type" field is empty.
Limit: creating campaign require at least one free campaign limit.

PHP example code:

examples/Monitoring/CampaignCreate.php

Curl:

curl -X POST -d '{ "domain": "example.com" }' https://api.semstorm.com/api-v3/monitoring/monitoring-campaign.json?services_token=__ACCESS_TOKEN__

Output:

{ "id": __ID__ }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/{_CAMPAIGN_ID_} [GET]

Description:
Get data about campaign.

Error:
Request: campaign with given id not exist for current user.

PHP example code:

examples/Monitoring/CampaignRetrieve.php

Curl:

curl https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/_CAMPAIGN_ID_.json?services_token=__ACCESS_TOKEN__

Output:

{"id": _CAMPAIGN_ID_, "domain":"example.com", "status":"active", "access_type":"owner", "created_time":"1460375898", "changed_time":"1460375898", "groups":[__GROUP_ID__, __GROUP_ID__ (...) ]}

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/{_CAMPAIGN_ID_} [PUT]

Description:
Change data of campaign.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Request: campaign with given id not exist for current user.

PHP example code:

examples/Monitoring/CampaignUpdate.php

Curl:

curl -X PUT -d '{ "domain": "example.com" }' https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/_ID_.json?services_token=__ACCESS_TOKEN__

Output:

[ true ]

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/start [POST]

Description:
Change status of campaign to active.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Request: campaign with given id not exist for current user.
Limit: activating campaign require at least one free campaign limit, and that much keywords as it have.

PHP example code:

examples/Monitoring/CampaignStart.php

Curl:

curl -X POST -d '{ "id": [ __CAMPAIGN_ID_1__, __CAMPAIGN_ID_2__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/start.json?services_token=__ACCESS_TOKEN__

Output:

{ __CAMPAIGN_ID_1__: 1, __CAMPAIGN_ID_2__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/stop [POST]

Description:
Change status of campaign to stop.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Request: campaign with given id not exist for current user.

PHP example code:

examples/Monitoring/CampaignStop.php

Curl:

curl -X POST -d '{ "id": [ __CAMPAIGN_ID_1__, __CAMPAIGN_ID_2__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/stop.json?services_token=__ACCESS_TOKEN__

Output:

{ __CAMPAIGN_ID_1__: 1, __CAMPAIGN_ID_2__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/delete [POST]

Description:
Change status of campaign to delete.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Campaign with given id not exist for current user.

PHP example code:

examples/Monitoring/CampaignDelete.php

Curl:

curl -X POST -d '{ "id": [ __CAMPAIGN_ID_1__, __CAMPAIGN_ID_2__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/delete.json?services_token=__ACCESS_TOKEN__

Output:

{ __CAMPAIGN_ID_1__: 1, __CAMPAIGN_ID_2__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/restore [POST]

Description:
Change status of campaign from delete to stop.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Campaign with given id not exist for current user.

PHP example code:

examples/Monitoring/CampaignRestore.php

Curl:

curl -X POST -d '{ "id": [ __CAMPAIGN_ID_1__, __CAMPAIGN_ID_2__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/restore.json?services_token=__ACCESS_TOKEN__

Output:

{ __CAMPAIGN_ID_1__: 1, __CAMPAIGN_ID_2__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/get-list [POST]

Description:
Get campaigns set selected by pager.

Error:
Throttling: Possible throttle prevention.

PHP example code:

examples/Monitoring/CampaignList.php

Curl:

curl -X POST -d '{ "pager": { "items_per_page":10, "page":1 } }' https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/get-list.json?services_token=__ACCESS_TOKEN__

Output:

{ "campaigns"[ (...) ], "count":27 }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/get-overview-data [POST]

Description:
Get information about campaigns, similar to data in monitoring dashboard.

Error:
Throttling: Possible throttle prevention.

Curl:

curl -X POST -d '{"gap": "monthly", "engine": 272 }' https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/get-overview-data.json?services_token=__ACCESS_TOKEN__

Output:

(see php example for example result)

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/get-data [POST]

Description:
Get details about campaign keywords. It is data from "Daily rank tracking" tab in Monitoring/Keywords page in system.
In filters array you (optionally) specify your filters. See filters section to know more about filters.
For PHP library users: filters in input can be set using SemstormFilters class, which makes it a lot simplier. For details about SemstormFilters class see examples/Explorer/FiltersExplain.php and examples/Explorer/FiltersUsage.php files.

Error:
Throttling: Possible throttle prevention.

PHP example code:

examples/Monitoring/CampaignData.php

Curl:

curl -X POST -d '{"id": _ID_, "datemin": "20160901", "datemax": "20170530", "gap": "monthly", "domains": ["example.com", "example2.pl"] }' https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/get-data.json?services_token=__ACCESS_TOKEN__

Output:

(see php example for example result)

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/get-access [POST]

Endpoint: /monitoring/monitoring-campaign/get-access [POST]

Description:
Returns information about campaigns you own or manage, with list of users that have access to given campaign (users by e-mail address).
Existing permissions are:
"owner" - this account can modify everything in campaign, add and remove roles. Its reserved for account which created campaign, and is persistent.
"manager" - this account can do everything as "owner" but this role can be removed.
"readonly" - account with that permission can only see campaign and its statistics, and cannot do any changes.

Error:
none.

PHP example code:

examples/Monitoring/CampaignGetAccess.php

Curl:

curl -X POST https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/get-access.json?services_token=__ACCESS_TOKEN__

Output:

(see php example for example result)

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/set-access [POST]

Description:
Set access to campaigns, you need to have proper access level to modify permissions in campaigns.
This api endpoint is limited to one request per 10 seconds.
By this api call you can alter maximum 3 accounts at once. That means "set" array shouldn't have more than 3 records. There is no limit in removing access.
Proper permissions to give and take are "readonly" and "manager". One more permission named "owner" is reserved for account which created campaign and cannot be modified.
If you will try to grant permission by entering e-mail on which there is no registered account in SEMSTORM system, then the invitation e-mail to craete account will be send.

Error:
Request: too fast requesting, if any campaign id invalid (user might not have permissions) or if access updating failed. Access updating will fail if: you try to modify permissions in campaign you have "readonly" access, you try to remove or change permission level of the owner of campaign, one or more e-mail address is invalid.
Throttling: this request is specially limited to one per 10 seconds.

PHP example code:

examples/Monitoring/CampaignSetAccess.php

Curl:

curl -X POST -d '{ "__CAMPAIGN_ID__": { "set": [ (...) ], "remove": [ (...) ] }}' https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/set-access.json?services_token=__ACCESS_TOKEN__

Output:

{ "result": { "__CAMPAIGN_ID__": { "set": [ (...) ], "remove": [ (...) ] } } }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-group [POST]

Description:
Create new group in specified campaign.

Error:
Request: any of required fields missing, campaign id invalid (user might not have permissions), engine-country invalid combination, devices array invalid.

PHP example code:

examples/Monitoring/GroupCreate.php

Curl:

curl -X POST -d '{ "campaign_id":__ID__, "title":"New group", "engine": 2, "country": 168, "location": "warszawa", "devices": ["mobile"] }' https://api.semstorm.com/api-v3/monitoring/monitoring-group.json?services_token=__ACCESS_TOKEN__

Output:

{ "id": "12345" }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-group/{_GROUP_ID_} [GET]

Description:
Get data about group.

Error:
Request: group id invalid (user might not have permissions).

PHP example code:

examples/Monitoring/GroupRetrieve.php

Curl:

curl https://api.semstorm.com/api-v3/monitoring/monitoring-group/_GROUP_ID_.json?services_token=__ACCESS_TOKEN__

Output:

{"id": _ID_, "title": "Group title", "status": "active", "created_time": "1415794727", "changed_time": "1415794727", "keywords": [ __KEYWORD_ID__, __KEYWORD_ID__, __KEYWORD_ID__, (...) ], "engine": "2", "country": "168","location": "warszawa","devices": ["desktop"]}

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-group/{_GROUP_ID_} [PUT]

Description:
Change data of group
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it..
To set "location" parameter to empty pass there empty string. This will be interpreted as no location specified.

Error:
Request: group with given id not exist for current user, engine-country invalid combination, devices array invalid.
Limit: updating group can change keywords usage. Eg. when changing from one device to both all keywords in group will be counted twice.

PHP example code:

examples/Monitoring/GroupUpdate.php

Curl:

curl -X PUT -d '{"title": "new name", "engine": 2, "country": 168, "location": "łódź", "devices": ["mobile", "desktop"]}' https://api.semstorm.com/api-v3/monitoring/monitoring-group/_ID_.json?services_token=__ACCESS_TOKEN__

Output:

[ true ]

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-group/start [POST]

Description:
Change status of group to active.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Request: group with given id not exist for current user.
Limit: activating group require that much keywords as it have.

PHP example code:

examples/Monitoring/GroupStart.php

Curl:

curl -X POST -d '{ "id": [ __GROUP_ID_1__, __GROUP_ID_2__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-group/start.json?services_token=__ACCESS_TOKEN__

Output:

{ __GROUP_ID_1__: 1, __GROUP_ID_2__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-group/stop [POST]

Description:
Change status of group to stop.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Request: group with given id not exist for current user.

PHP example code:

examples/Monitoring/GroupStop.php

Curl:

curl -X POST -d '{ "id": [ __GROUP_ID_1__, __GROUP_ID_2__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-group/stop.json?services_token=__ACCESS_TOKEN__

Output:

{ __GROUP_ID_1__: 1, __GROUP_ID_2__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-group/delete [POST]

Description:
Change status of group to delete.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Request: group with given id not exist for current user.

PHP example code:

examples/Monitoring/GroupDelete.php

Curl:

curl -X POST -d '{ "id": [ __GROUP_ID_1__, __GROUP_ID_2__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-group/delete.json?services_token=__ACCESS_TOKEN__

Output:

{ __GROUP_ID_1__: 1, __GROUP_ID_2__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-group/restore [POST]

Description:
Change status of group to stop.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Request: group with given id not exist for current user.

PHP example code:

examples/Monitoring/GroupRestore.php

Curl:

curl -X POST -d '{ "id": [ __GROUP_ID_1__, __GROUP_ID_2__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-group/restore.json?services_token=__ACCESS_TOKEN__

Output:

{ __GROUP_ID_1__: 1, __GROUP_ID_2__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-group/get-list [POST]

Description:
Gets list of campaign groups.

Error:
Request: campaign with given id not exist for current user.

PHP example code:

examples/Monitoring/GroupList.php

Curl:

curl -X POST -d '{ "campaign_id": 7189, "pager": { "items_per_page": 10, "page": 1 } }' https://api.semstorm.com/api-v3/monitoring/monitoring-group/get-list.json?services_token=__ACCESS_TOKEN__

Output:

(see php example for example result)

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/get-data [POST]

Description:
Simpliest way to retrieve keywords data is by using "group"-"entity" filter with group id. See example for details.

Error:
Throttling: Possible throttle prevention.

PHP example code:

examples/Monitoring/GroupData.php

Curl:

curl -X POST -d '{ "id": __CAMPAIGN_ID_1__, "filters": {"type": "include", "field": "group_nid_mv", "op": "entity", "value": [ [__GROUP_ID_1__: __GROUP_ID_1__] ]}, (...) }' https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/get-data.json?services_token=__ACCESS_TOKEN__

Output:

(see php example for example result)

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-group/create-multiple [POST]

Description:
Create multiple groups in campaign. Its behavior is very similar to creating one group, except it takes array with groups params to create multiple groups.
"Groups" variable can be assoc array, instead of normal array - in that case returning information about each group creation will preserve keys so you can easily determine which output is for which group.

Error:
Request: campaign with given id not exist for current user, any groups data invalid.

PHP example code:

examples/Monitoring/GroupCreateMultiple.php

Curl:

curl -X POST -d '{ "campaign_id": 1234, "groups": { "new group 1": (...), "new group 2": (...) } }' https://api.semstorm.com/api-v3/monitoring/monitoring-group/create-multiple.json?services_token=__ACCESS_TOKEN__

Output:

{ "id":{ "new group 1": 123456, "new group 2": 123457 } }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-group/update-multiple [POST]

Description:
Update multiple groups in campaign. Its behavior is very similar to updating one group, except it takes array with groups params to update multiple groups.

Error:
Request: group with given id not exist for current user, any group data invalid.

PHP example code:

examples/Monitoring/GroupUpdateMultiple.php

Curl:

curl -X POST -d '{ "groups": { "__GROUP_ID_1__": {(...)}, "__GROUP_ID_2__": {(...)} } }' https://api.semstorm.com/api-v3/monitoring/monitoring-group/update-multiple.json?services_token=__ACCESS_TOKEN__

Output:

{ "id":{ __GROUP_ID_1__: true, __GROUP_ID_2__: true } }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-keyword [POST]

Description:
Create new keywords in group.

Error:
Request: group with given id not exist for current user.

PHP example code:

examples/Monitoring/KeywordCreate.php

Output:

curl -X POST -d '{ "group_id": _ID_, "keywords": [ "keyword 1", "keyword 2", "keyword 3", (...)] }' https://api.semstorm.com/api-v3/monitoring/monitoring-keyword.json?services_token=__ACCESS_TOKEN__

Output:

{ "id": [ "12345", "12346", "12347", (...) ] }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/{_KEYWORD_ID_} [GET]

Description:
Get data about keyword.

Error:
Request: keyword with given id not exist for current user.

PHP example code:

examples/Monitoring/KeywordCreate.php

Curl:

curlhttps://api.semstorm.com/api-v3/monitoring/monitoring-keyword/_KEYWORD_ID_.json?services_token=__ACCESS_TOKEN__

Output:

{ "id": "_ID_", "title": "keyword 1", "status": "active", "group_id": "_GROUP_ID_" }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/start [POST]

Description:
Change status of keywords to active.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Request: keyword with given id not exist for current user.
Limit: activating keyword require at least one free keyword limit.

PHP example code:

examples/Monitoring/KeywordCreate.php

Curl:

curl -X POST -d '{ "id": [ __KEYWORD_ID_1__, __KEYWORD_ID_2__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/start.json?services_token=__ACCESS_TOKEN__

Output:

{ __KEYWORD_ID_1__: 1, __KEYWORD_ID_2__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/stop [POST]

Description:
Change status of keywords to stop.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Request: keyword with given id not exist for current user.

PHP example code:

examples/Monitoring/KeywordStop.php

Curl:

curl -X POST -d '{ "id": [ __KEYWORD_ID_1__, __KEYWORD_ID_2__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/stop.json?services_token=__ACCESS_TOKEN__

Output:

{ __KEYWORD_ID_1__: 1, __KEYWORD_ID_2__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/delete [POST]

Description:
Change status of keywords to delete.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Request: keyword with given id not exist for current user.

PHP example code:

examples/Monitoring/KeywordDelete.php

Curl:

curl -X POST -d '{ "id": [ __KEYWORD_ID_1__, __KEYWORD_ID_2__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/delete.json?services_token=__ACCESS_TOKEN__

Output:

{ __KEYWORD_ID_1__: 1, __KEYWORD_ID_2__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/restore [POST]

Description:
Change status of keywords from deleted to stoped.
This call is in critical section, which means it locks access to entity it operates on for the execution time. When locked no other critical actions may take place. Also this call may fail if anything else locked current entity before it.

Error:
Request: keyword with given id not exist for current user.

PHP example code:

examples/Monitoring/KeywordRestore.php

Curl:

curl -X POST -d '{ "id": [ __KEYWORD_ID_1__, __KEYWORD_ID_2__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/restore.json?services_token=__ACCESS_TOKEN__

Output:

{ __KEYWORD_ID_1__: 1, __KEYWORD_ID_2__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/change-group [POST]

Description:
Takes keywords and move them to specified group. Each keyword can be from different group/campaign as long as you have access to edit those.

Error:
Request: group with given id not exist for current user. Any of keyword id is invalid. Limits exceeded - this is possible eg. if you move keywords from group with one device to other with two.

PHP example code:

examples/Monitoring/KeywordChangeGroup.php

Curl:

curl -X POST -d '{ "group_id": __GROUP_ID__, "id": [ __KEYWORD_ID__, __KEYWORD_ID__, (...) ] }' https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/change-group.json?services_token=__ACCESS_TOKEN__

Output:

{ __KEYWORD_ID__: 1, __KEYWORD_ID__: 1, (...) }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/get-list [POST]

Description:
Gets list of campaign keywords.
Important! If you put "delete" into status filter, you will see only deleted keywords, and other statuses will be ignored.
Use "active" and "stop" separately from "delete" filter.

Error:
Request: campaign with given id not exist for current user.

PHP example code:

examples/Monitoring/KeywordList.php

Curl:

curl -X POST -d '{ "campaign_id": _ID_, "pager": { "items_per_page": 25, "page": 1 } }' https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/get-list.json?services_token=__ACCESS_TOKEN__

Output:

{ "count": 123, "keywords": [ (...)] }

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/get-data [POST]

Description:
Simpliest way to retrieve keywords data is by using "keyword"-"equals" filter with keyword full name. See example for details.

Error:
Throttling: Possible throttle prevention.

PHP example code:

examples/Monitoring/KeywordData.php

Curl:

curl -X POST -d '{ "id": __CAMPAIGN_ID_1__, "filters": {"type": "include", "field": "keyword", "op": "equal", "value": [ "kredyt" ]}, (...) }' https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/get-data.json?services_token=__ACCESS_TOKEN__

Output:

(see php example for example result)

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/get-details [POST]

Description:
Retrieve details about keywords. Each of keyword (idetified by keyword id) can have few results, depending on group device count it is in.
Output differs depends on chosen "type".

Error:
Throttling: Possible throttle prevention.

PHP example code:

examples/Monitoring/KeywordList.php

Curl:

curl -X POST -d '{ "id": [ __KEYWORD_ID_1__, (...) ], "params": { "type": "competitors", (...) } }' https://api.semstorm.com/api-v3/monitoring/monitoring-keyword/get-details.json?services_token=__ACCESS_TOKEN__

Output:

(see php example for example result)

Endpoint: https://api.semstorm.com/api-v3/monitoring/monitoring-tables/{_TABLE_NAME_} [GET]

Description:
This endpoint is used to retrieve information about current API params.
Currently there are two tables possible to retrieve: "engines" which contains full set of engine-country ids collection, and "devices" which is lsit of possible devices names.

Error:
Wrong table name.

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-tables/engines [GET]

Description:
Return table containing all possible engines and countries variations.

Error:
None.

PHP example code:

examples/Monitoring/TablesEngines.php

Curl:

curl https://api.semstorm.com/api-v3/monitoring/monitoring-tables/engines.json?services_token=__ACCESS_TOKEN__

Output:

(see php example for example result)

Endpoint:
https://api.semstorm.com/api-v3/monitoring/monitoring-tables/devices [GET]

Description:
Return table containing proper devices names.

Error:
None.

PHP example code:

examples/Monitoring/TablesDevices.php

Curl:

curl https://api.semstorm.com/api-v3/monitoring/monitoring-tables/devices.json?services_token=__ACCESS_TOKEN__

Output:

{"devices": [ "mobile", "desktop" ]}

Passing invalid token (or not passing at all) in request will result in authorization error.

PHP example code:

examples/Monitoring/ErrorAuthorization.php

Curl:

curl https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/_ID_.json?services_token=this-is-wrong-access-token

Output:

[ "Unauthorised access." ]

When error occurs you can check "message" in "error" variable returned from server.

PHP example code:

examples/Monitoring/ErrorSimple.php

Curl:

curl https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/123456.json?services_token=__ACCESS_TOKEN__

Output:

{"error": { "message": "(404) No entry for given id." }

In some requests errors returns more information. For example bulk operations returns array with information which operations succeded and which failed.

PHP example code:

examples/Monitoring/ErrorBulk.php

Curl:

curl -X POST -d '{ "id": [_CAMPAIGN_ID_1_, _CAMPAIGN_ID_2_, (...)] }' https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/start.json?services_token=__ACCESS_TOKEN__

Output:

(see php example for example result)

Error with code 503 in most cases will concern throttle prevention. If error message will contain "Throttle prevention. Data may be incomplete(...)" that means system was overloaded and refused to sustain connection.
This is temporary problem, you can retry your request after few secons - just remember that very large request will require more time to wait.
If problem sustains it propably means you are requesting too big set of data at once. Try split it into few smaller requests.

PHP example code:

There is no example of this error, as it happens occasionaly for big set of data.

Curl:

There is no example of this error, as it happens occasionaly for big set of data.

Output:

{ "params": {(...)}, "error": { "message": "(503) Service unavailable. Throttle prevention. Data may be incomplete. Try again later.", "result": {(...)} } }