PRpromptingcompany
Visibility & Mentions

Get share of voice accumulated over a date range

get/api/v1/analytics/sov

Request

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

Query parameters

productIdstring required

Product ID to use as the share of voice scope.

viewIdstring

View ID to restrict the calculation to the view's prompts.

enginestring

Answer engine to include in the calculation.

regionIdstring

Region to include in the calculation.

startstring

First UTC day included in the calculation, formatted as YYYY-MM-DD. Must be supplied with end. Defaults to 29 days before today.

endstring

Last UTC day included in the calculation, formatted as YYYY-MM-DD. Must be supplied with start. Defaults to today.

Response

Successful response

oktrue required

Changes

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