analytics

Visibility time-series

Returns the share of analyzed responses that mention each tracked brand, bucketed by interval. You may scope the chart to a single brand by passing brand_id, or to every brand in a segment by passing segments. Otherwise, the result is capped to the top top_n brands by mention count, which defaults to 20 and may not exceed 50.

get/api/v1/analytics/visibility-time-series

Request

  • Base URL: https://pineprompt.com
  • URL: https://pineprompt.com/api/v1/analytics/visibility-time-series
  • Auth: HTTP bearer

Query parameters

start_datestring date required
Example:2026-04-01

The inclusive UTC start of the analytics window, given as an ISO 8601 date (YYYY-MM-DD).

end_datestring date required
Example:2026-05-20

The inclusive UTC end of the analytics window. The value must be on or after start_date, and on or before today.

interval'day' | 'week' | 'month' | 'year' required
Example:day

The bucketing granularity for time-series endpoints. Accepted values: day, week, month, and year. Week buckets begin on Monday.

brand_idinteger
Example:555

You may set this parameter to scope a time-series chart to a single brand, which produces a single-brand line. The brand must belong to the active project. A single-brand share-of-voice series is measured against the brand's own mentions, so it reads 100 in any bucket where the brand has mentions.

platformsstring[]

You may use this parameter to limit responses to one or more AI platforms. Repeat the parameter for each value, for example ?platforms[]=chatgpt&platforms[]=claude. When omitted, every platform is included. Accepted values: chatgpt, perplexity, gemini, grok, copilot, claude, google_ai_mode, and google_ai_overview.

countriesstring[]

You may use this parameter to limit responses to monitors run in the given ISO-3166-1 alpha-2 country codes.

[
  "US",
  "NL"
]
monitorsinteger[]

You may use this parameter to limit responses to specific monitors inside the active project.

[
  271,
  272
]
segmentsinteger[]

You may use this parameter to limit responses and brand-scoped metrics to brands attached to any of the given segments. Segments are named groupings of brands, such as Direct Competitors. When this parameter is set, time-series charts show every brand in the selected segments instead of capping the series at top_n, and share-of-voice ratios are computed within the segment, so each brand's share reads against the other brands in the selected segments. Source-keyed endpoints do not honor this parameter.

[
  12
]
tagsinteger[]

You may use this parameter to limit responses to those whose prompt carries any of the given tag IDs, such as branded or non-branded.

[
  3,
  5
]
top_ninteger
Example:20

The maximum number of series to return from a time-series endpoint. Series are ranked by total mentions or citations in the window. Defaults to 20, with a maximum of 50.

Headers

Pineprompt-Project-Idinteger required

The active project's numeric ID.

Response

OK

interval'day' | 'week' | 'month' | 'year'

The bucket granularity used to compute the series.

Example response

{
  "interval": "day",
  "series": [
    {
      "brand": {
        "id": 555,
        "project_id": 42,
        "display_name": "Acme Inc.",
        "aliases": [
          "Acme",
          "Acme Co"
        ],
        "domains": [
          "acme.com",
          "acme.co"
        ],
        "kind": "competitor",
        "color": "#008FFB",
        "project": {
          "id": 42,
          "organization_id": 7,
          "name": "Acme Marketing",
          "brand_id": 555,
          "organization": {
            "id": 7,
            "name": "Acme Inc.",
            "created_at": "2026-05-15T09:11:42+00:00",
            "updated_at": "2026-05-15T09:11:42+00:00"
          },
          "created_at": "2026-05-15T09:11:42+00:00",
          "updated_at": "2026-05-15T09:11:42+00:00"
        },
        "created_at": "2026-05-15T09:11:42+00:00",
        "updated_at": "2026-05-15T09:11:42+00:00"
      },
      "data": [
        {
          "timestamp": "2026-04-01T00:00:00+00:00",
          "value": 73
        }
      ]
    }
  ]
}

Changes

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