Get visibility score

Percentage of responses containing the target brand. data.value is the weighted aggregate for the full selected period, calculated from the sum of the underlying numerators divided by the sum of the underlying denominators; it is not an arithmetic average of data.series values. Dates are inclusive UTC calendar dates; organization and project access come from the API key and cannot be overridden. Empty data returns null.

GET /v1/organizations/{organizationId}/projects/{projectId}/analytics/visibility-score
Bearer token

Path parameters

· 2
organizationId string required
projectId string required

Query parameters

· 8
startDate string · date

Inclusive UTC date (YYYY-MM-DD). Defaults to 29 days before endDate.

endDate string · date

Inclusive UTC date (YYYY-MM-DD). Defaults to today. Maximum range is 366 days.

monitorId string

Optional monitor belonging to the authorized project.

tagIds string

Comma-separated prompt-tag IDs belonging to the authorized project and optional monitor.

promptTypes string

Comma-separated prompt types. Values use OR semantics within this filter and combine with other filters using AND semantics. For example, Generic,Branded includes either prompt type.

promptIds string

Comma-separated prompt IDs belonging to the authorized project and optional monitor. Values use OR semantics within this filter and combine with other filters using AND semantics.

country string · pattern

Two-letter uppercase execution market configured on prompts.

interval string · default: day· enum

UTC time-series bucket.

values

  • day
  • week
  • month

Responses