Sign in

v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Rank Tracker Describe

In order to query the Rank Tracker APIs, you’ll need to get your Campaign IDs and Scraping Configurations. Start by calling this API to get your campaign meta data

get/reports/describe

Query parameters

api_keystring

Response

200

Example response

{
  "response": {
    "describe": {
      "lastAvailableDate": "2024-03-20",
      "campaigns": [
        {
          "campaignId": "e3be9db7-2caa-43d9-be9d-ebd4902b1671",
          "campaignName": "Nike Staging Eilon Campaign",
          "userCreatedBy": "Eilon Benami",
          "scrapingConfigurations": [
            {
              "id": "2acc0011-eca3-4b7e-8a98-33a2987759dc",
              "searchEngine": "Google",
              "location": "Israel",
              "device": "Desktop",
              "language": "iw-il"
            }
          ],
          "tags": [
            "brand"
          ],
          "createdTime": "2023-02-22",
          "competitors": [
            "footlocker.com"
          ],
          "mainDomain": "nike.com"
        }
      ],
      "availableSorts": [
        "volume"
      ]
    }
  }
}