PRpromptingcompany
Visibility & Mentions

Get rolling share of voice time series and breakdowns

get/api/v1/analytics/sov/timeseries

Request

  • Base URL
    https://app.promptingco.com
  • URL
    https://app.promptingco.com/api/v1/analytics/sov/timeseries
  • Auth
    • API key in header x-api-key
    • or HTTP bearer
    • or API key in cookie better-auth.session_token

Query parameters

productIdstring

Product ID to use as the primary SOV scope.

brandIdstring

Deprecated. Use productId instead. Product ID to use as the primary SOV scope.

by'prompt' | 'topic' | 'engine' | 'competitor' | 'sentiment'
viewIdstring

View ID to scope results to the view's prompts. Not supported with by=topic or topicId.

promptIdstring
topicIdstring
enginestring
regionIdstring
granularity'day' | 'week' | 'month'

UTC calendar bucket used for time-series points and as the unit for rollingWindow. Week buckets start on Monday.

rollingWindowinteger

Number of granularity buckets included in each time-series point. Accepts 1 through 30 and defaults to 30.

startstring

Selects the earliest calendar bucket returned. Must be supplied with end. For week or month granularity, the containing bucket starts before this date and includes those earlier dates in its rolling calculation.

endstring

Selects the latest calendar bucket returned. Must be supplied with start. For week or month granularity, the containing bucket is returned with data accumulated only through this date.

pinnedboolean

Only valid with by=competitor. When true, return only the product's pinned competitors' SoV (paginated over the pinned subset).

pageinteger
pageSizeinteger
sortBy'sov' | 'mentions' | 'runs' | 'label'
sortDirection'asc' | 'desc'

Response

Successful response

oktrue required

Changes

No recorded changes to this operation across all 1 revision of this API.