v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Rank Tracking Keywords Position Trend

Monitor daily positions of your site or your named competitors’ sites. Get the position and top url of the queried site per day.

get/{campaign_id}/reports/keywords-report/trend

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 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

position_filterstring

Positions to filter (fromat: Min_number-Max_number). for example: "1-3"

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

devicestring

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

campaign_idstring

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

formatstring

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

Response

200

keywordstring

topUrlstring

geoLocationstring

datestring

positioninteger

Example response

[
  {
    "keyword": "1985 amazon prime",
    "topUrl": "amazon.com/1985-Cory-Michael-Smith/dp/B07KGKKVDM",
    "geoLocation": "United Kingdom",
    "date": "2024-01-12",
    "position": 3
  }
]