---
title: "Share-of-voice time-series"
method: GET
path: "/api/v1/analytics/share-of-voice-time-series"
tags: ["analytics"]
---

# Share-of-voice time-series

`GET /api/v1/analytics/share-of-voice-time-series`

## Request

- Base URL: `https://pineprompt.com`
- URL: `https://pineprompt.com/api/v1/analytics/share-of-voice-time-series`
- Auth: HTTP bearer

Returns each tracked brand's mentions as a share of the mentions of the brands in the filter scope, per bucket. Without a `brand_id` or `segments` parameter, the scope is every tracked brand in the project. You may pass `segments` to read each share within the selected segments, since the segment scopes both the series and the denominator, or `brand_id` to scope the ratio to a single brand, which reads `100` in any bucket where the brand has mentions and `0` where it has none. The `top_n` cap only limits how many series are returned and never affects the denominator.

## Query parameters

- `start_date` string, date, required
- `end_date` string, date, required
- `interval` 'day' | 'week' | 'month' | 'year', required
- `brand_id` integer
- `platforms` string[]
- `countries` string[]
- `monitors` integer[]
- `segments` integer[]
- `tags` integer[]
- `top_n` integer

## Headers

- `Pineprompt-Project-Id` integer, required

## Response `200`

OK

- ShareOfVoiceTimeSeries: A share-of-voice time series: one entry per brand in scope, each carrying a dense list of buckets tracing the brand's share of voice across the filter window.
  - `interval` 'day' | 'week' | 'month' | 'year': The bucket granularity used to compute the series.
  - `series` BrandShareOfVoiceSeries[]: One entry per brand in scope, each carrying a dense list of buckets.
    - `brand` Brand: A brand is an entity Pineprompt matches against platform answers: your own brand, a competitor you track, or a brand discovered in an answer. Matches are found through the display name, the aliases, and the domains.
      - `id` integer: The unique ID of the brand.
      - `project_id` integer: The ID of the project the brand belongs to.
      - `display_name` string: The canonical display name of the brand.
      - `aliases` string[]: Alternative names that the brand is referred to by.
      - `domains` string[]: The web domains associated with the brand.
      - `kind` 'own' | 'competitor' | 'discovered' | 'ignored': The brand's classification, derived from its context rather than stored: the brand the project's `brand_id` points at is `own`, a brand with `ignored_at` set is `ignored`, a brand attached to any segment is a `competitor`, and a brand with none of those is `discovered`. This field is read-only.
      - `color` string: A hex color used to color the brand consistently across charts. It is derived from the brand's favicon, or assigned automatically when no color can be derived. This field is read-only and is always present.
      - `ignored_at` string, date-time, nullable: When the brand was ignored, or null while it is not. Set and cleared through the `ignored` field on the update endpoint.
      - `project` Project: A project represents a single brand or site you monitor. Its `brand_id` names the own brand, the brand every core metric is computed for.
        - `id` integer: The unique ID of the project.
        - `organization_id` integer: The ID of the organization that owns the project.
        - `name` string: The display name of the project.
        - `brand_id` integer, nullable: The ID of the project's own brand, or null while none has been designated.
        - `organization` Organization: An organization is the top-level billing entity and tenant boundary in Pineprompt. Every project, member, and API key belongs to exactly one organization.
          - `id` integer: The unique ID of the organization.
          - `name` string: The display name of the organization.
          - `created_at` string, date-time: When the organization was created.
          - `updated_at` string, date-time: When the organization was last updated.
        - `created_at` string, date-time: When the project was created.
        - `updated_at` string, date-time: When the project was last updated.
      - `created_at` string, date-time: When the brand was created.
      - `updated_at` string, date-time: When the brand was last updated.
    - `data` TimeSeriesPoint[]: The bucketed data points for this brand. Each value is the brand's mentions expressed as a percentage of the mentions of the brands in the filter scope in the bucket.
      - `timestamp` string, date-time: The ISO 8601 UTC start of the bucket.
      - `value` integer: The metric value for this bucket. The series that carries the point describes what the value measures.

## Other responses

- `400`: Missing project header
- `401`: Unauthorized
- `403`: Missing ability
- `404`: Project not in this organization
- `422`: Validation failed

---

[API](https://skmtc.dev/pineprompt/apis/pineprompt-api.md) · [All operations](https://skmtc.dev/pineprompt/apis/pineprompt-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pineprompt/apis/pineprompt-api/revisions/05dbb5241a27?raw)