Skip to main content
GET
/
api
/
v1
/
analytics
/
sov
Get share of voice analytics for a product
curl --request GET \
  --url https://app.promptingco.com/api/v1/analytics/sov \
  --header 'x-api-key: <api-key>'
{
  "ok": true,
  "data": {
    "scope": {
      "product": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>"
      }
    },
    "pagination": {
      "page": 123,
      "pageSize": 123,
      "total": 123,
      "totalPages": 123
    },
    "sort": {
      "sortableDimensions": [
        "sov"
      ],
      "sortBy": "sov",
      "sortDirection": "asc"
    },
    "timeSeries": [
      {
        "date": "<string>",
        "sov": 123,
        "mentions": 123,
        "runs": 123
      }
    ],
    "products": [
      {
        "product_id": "<string>",
        "product_name": "<string>",
        "sov": 123,
        "mentions": 123,
        "runs": 123,
        "date": "<string>"
      }
    ],
    "rows": [
      {
        "dimension": "product",
        "key": "<string>",
        "label": "<string>",
        "sov": 123,
        "mentions": 123,
        "runs": 123,
        "date": "<string>",
        "rank": 123
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.promptingcompany.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, and prompt analysis results
  • prompts:write: Create, update, archive prompts
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Query Parameters

productId
string

Product ID to use as the primary SOV scope.

Minimum string length: 1
brandId
string
deprecated

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

Minimum string length: 1
by
enum<string>
Available options:
prompt,
topic,
engine
promptId
string
Minimum string length: 1
topicId
string
Minimum string length: 1
engine
string
Minimum string length: 1
start
string
end
string
page
integer
default:1
Required range: x >= 1
pageSize
integer
default:20
Required range: 1 <= x <= 100
sortBy
enum<string>
Available options:
sov,
mentions,
runs,
label
sortDirection
enum<string>
Available options:
asc,
desc

Response

Successful response

ok
enum<boolean>
required
Available options:
true
data
object
required