Rank Tracking Campaign Overview

get

https://api.similarweb.com/v4/rank-tracker/{campaign_id}/reports/overview-report/performanceOverTime?api_key={API_KEY}&start_date=2023-12-01&end_date=2024-01-01&device=Desktop&site={SITE}&scraping_configurations={SCRAPING CONFIG ID}

Get the aggregate metrics on a campaign level across all keywords, including weighted average position, weighted visibility, clicks and Share Of Voice.

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 Add_Your_API_KEY

Your Similarweb API key.

start_date

string

required

Defaults to 2023-01

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

end_date

string

required

Defaults to 2023-03

End month (format: YYYY-MM)

scraping_configurations

string

an array of IDs separated by commas, derived from the campaign record on the describe endpoint. Cannot be empty, cannot have IDs that are not part of the campaign

site

string

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

device

string

Defaults to desktop

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

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