---
title: "Get share of voice accumulated over a date range"
method: GET
path: "/api/v1/analytics/sov"
tags: ["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: one of:
  - API key in header `x-api-key`
  - HTTP bearer
  - API key in cookie `better-auth.session_token`

## Query parameters

- `productId` string, required: Product ID to use as the share of voice scope.
- `viewId` string: View ID to restrict the calculation to the view's prompts.
- `engine` string: Answer engine to include in the calculation.
- `regionId` string: Region to include in the calculation.
- `start` string: First UTC day included in the calculation, formatted as YYYY-MM-DD. Must be supplied with end. Defaults to 29 days before today.
- `end` string: Last UTC day included in the calculation, formatted as YYYY-MM-DD. Must be supplied with start. Defaults to today.

## Response `200`

Successful response

- object
  - `ok` true, required
  - `data` object, required
    - `scope` object, required
      - `product` object, required
        - `id` string, required
        - `name` string, required
        - `slug` string, required
    - `period` object, required
      - `start` string, required: First included UTC calendar day, formatted as YYYY-MM-DD.
      - `end` string, required: Last included UTC calendar day, formatted as YYYY-MM-DD.
      - `days` integer, required: Number of included calendar days.
    - `calculation` 'date_range', required: Confirms that counts were accumulated over the period before the ratio was calculated.
    - `sov` number, required: Share of voice percentage for the whole period. This is mentions divided by runs, multiplied by 100.
    - `mentions` integer, required: Completed runs in the period that mentioned the product.
    - `runs` integer, required: Completed runs in the period.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Forbidden
- `404`: Not found
- `422`: Validation failed
- `500`: Internal server error

---

[API](https://skmtc.dev/promptingcompany/apis/the-prompting-company-api.md) - [All operations](https://skmtc.dev/promptingcompany/apis/the-prompting-company-api/llms.txt) - [OpenAPI document](https://skmtc.dev/promptingcompany/apis/the-prompting-company-api/revisions/c0451ea10e9a?raw)