Operation details
#Reports the products ChatGPT showed in the project's measured answers: totals, the previous window's totals, daily series, tracked brands, retailers, products, prompts, searches and labels. Counts only; derive rates from their numerators and denominators. Dates are inclusive UTC run dates, at most 366 days; omitted dates select the last 30 days. The previous window defaults to the equal-length window before from; previous is null when it ends before capture started. Topics filter to prompts in those project topics. Before capture starts, capture.first_captured_on is null and every total is 0.
Authentication and scopes
#Send your workspace API key in the Authorization: Bearer YOUR_API_KEY header. This operation requires read.
See Authentication for key setup and project access.
Path parameters
#| Parameter | Type | Requirement | Details |
|---|---|---|---|
projectId | string | Required | Format: uuid. |
Query parameters
#| Parameter | Type | Requirement | Details |
|---|---|---|---|
from | string | Optional | Pattern: ^\d{4}-\d{2}-\d{2}$. |
to | string | Optional | Pattern: ^\d{4}-\d{2}-\d{2}$. |
previousFrom | string | Optional | Pattern: ^\d{4}-\d{2}-\d{2}$. |
previousTo | string | Optional | Pattern: ^\d{4}-\d{2}-\d{2}$. |
topics | array of string | Optional | Minimum items: 1. Maximum items: 100.Parameter schema |
Array query values use comma-separated values. Cross-field rules and date-window checks are also enforced by the API. See Pagination and filters.
Response envelope
#Successful JSON responses return the operation’s result under data and a request identifier under meta.requestId. Collection results include their own pagination or coverage metadata. The payload inside data varies by operation.
The OpenAPI document defines shared success and error envelopes. It does not define every operation’s returned data fields or promise that every operation returns every listed success status. See the request and response guide and workflow examples for documented payloads.
Errors and retries
#Check the HTTP status and stable error.code. Keep meta.requestId when investigating a failed request. Follow Retry-After when it is present, and check existing job or resource state before retrying a write.
See Errors and limits for validation, permissions, conflicts, and temporary queue denials.