REST API

NetMarketShare supports REST calls to retrieve data. REST stands for Representational State Transfer, and can be thought of as an HTTP-based API. A REST API is a set of operations that can be invoked using the actual URI as parameters for your operations.

The API uses JSON for the queries. The query endpoint is:

https://gatorapi.com/v1/marketshare/query

An example query to post (see the page on the query language for details):

{
  "accessToken": "YOUR ACCESS TOKEN",
  "query": {
    "timeframe": "lastMonth",
    "group": "browser",
    "sort": {
        "share": -1
    },
    "filter": {
        "deviceType": "Desktop/laptop"
    },
    "attributes": "share"
  }
}

A CURL example:

curl -X POST "https://gatorapi.com/v1/marketshare/query" -H "accept: application/json" -H "content-type: application/json" -d "{ \"accessToken\": \"YOUR ACCESS TOKEN\", \"query\": { \"timeframe\": \"lastMonth\", \"group\": \"browser\", \"sort\": { \"share\": -1 }, \"filter\": { \"deviceType\": \"Desktop/laptop\" }, \"attributes\": \"share\" }}"

For security purposes, it is required that the HTTPS protocol is used for all REST calls.

Authentication of REST calls

The REST API requires the use of an access token, which identifies the account and acts as a password for the call.

Access tokens can be revoked by the account owner at any time.

REST API calls are required to use the HTTPS protocol.  By using HTTPS, the information passed to the call is encrypted.

You must be a subscriber to generate an access token. Once you've subscribed, a new menu item will appear, 'Developers/Access Tokens'. To generate an access token, go to the 'Access Tokens' menu item.

Click here for the query language syntax

Click here to test queries

Click here to see a list of supported data entities and attributes

Click here for the API Explorer