Rank Tracking Keywords Snapshot

get

https://api.similarweb.com/v4/rank-tracker/{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}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

campaign_id

string

required

Defaults to {campaign_id}

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

Query Params

api_key

string

required

Defaults to api_key

Your Similarweb API key.

start_date

string

required

Defaults to 2023-01-01

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

end_date

string

required

Defaults to 2023-03-01

End month (format: YYYY-MM)

scraping_configurations

string

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

device

string

Defaults to desktop

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

site

string

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

sort

string

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

tags

string

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

format

string

Defaults to json

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

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200