v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Rank Tracking Keywords Snapshot

Get the core keyword metrics, along with the most up-to-date position within the inputted time frame and position change

get/{campaign_id}/reports/keywords-report/table?api_key={api_key}&start_date={start_date}&end_date={end_date}&device={device}&site={site}&scraping_configurations={scraping_configurations}

Path parameters

campaign_idstring required

Enter a campaign ID, as defined on the Similarweb platform. Without brackets {}

Query parameters

api_keystring required

Your Similarweb API key.

start_datestring required

Start month (format: YYYY-MM): we have up to 3 month Historical Data

end_datestring required

End month (format: YYYY-MM)

scraping_configurationsstring required

an array of Id's seperated by commas, derived from the campaign record on the describe endpoint. Cannot be empty, cannot have id's that are not part of the campaign

devicestring

The device to return data for. Possible values:'mobile' or 'desktop'

sitestring

The website which we want to see position data for. Should be chosen from the competitors \ main domain of campaign. defaulted to main domain of the campaign

sortstring

sort field, a list of available sorts will be provided within the describe endpoint. empty sort will result in sorting by default - volume

tagsstring

a list of tags in order to filter the campaigns (groups of keywords). An array of tags separated by commas I.E tags=tag1,tag2

formatstring

[optional] Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'.

Response

200

Example response

{
  "meta": {
    "query": {
      "pageSize": 1000,
      "page": 1,
      "limit": 100,
      "sort": "Volume"
    },
    "request": {
      "campaignId": "cbe0ea73-0acb-482e-9a4f-7b112e1a5a72",
      "startDate": "2023-12-01",
      "endDate": "2024-02-11",
      "format": "json",
      "scrapingConfigurations": [
        "737b8c82-0633-405c-9705-e1e9a5f37c81"
      ],
      "site": "nike.com"
    },
    "status": "Success"
  },
  "keywordsTable": [
    {
      "keyword": "nike",
      "topUrl": "nike.com/gb/",
      "location": "England,United Kingdom",
      "tags": [
        "nike"
      ],
      "volume": 488847,
      "cpc": 0.2,
      "keywordDifficulty": 91,
      "intent": "Navigational",
      "siteSerpFeatures": [
        "paid"
      ],
      "keywordSerpFeatures": [
        "knowledge"
      ],
      "position": 1
    }
  ]
}