v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Rank Tracking Campaign Overview

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

get/{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}

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

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

sitestring

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

devicestring

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

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
    },
    "request": {
      "campaignId": "885fab59-31ef-4084-b753-5eee637cacc9",
      "startDate": "2024-01-12",
      "endDate": "2024-02-12",
      "format": "json",
      "scrapingConfigurations": [
        "00a02a46-0595-473e-b61c-2693655b39ec"
      ],
      "site": "amazon.com"
    },
    "status": "Success"
  },
  "overTimeRecords": [
    {
      "site": "amazon.com",
      "date": "2024-01-12",
      "visibility": 0.9373240919957454,
      "avgWeightPosition": 3.311449063895815,
      "clicks": 25805.816249045198,
      "shareOfVoice": 0.0149
    }
  ]
}