COcooper-square-technologies
Reports
Reports

Stream Citations

Changed on
post/v1/reports/citations/stream

Request

Request body

date_interval'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' | 'relative_week'

Date interval for the report. (only used with date dimension)

dimensionsstring[]

Dimensions to group the report by.

metricsstring[] required

Metrics to include. share_of_voice is deprecated, use citation_share instead.

order_byobject 
Custom ordering of the report results.

The order is a record of key-value pairs where:
- `key` is the field to order by, which can be a metric or dimension
- `value` is the direction of the order, either `asc` for ascending or `desc` for descending.

When not specified, the default order is the first metric in the query descending.
category_idstring uuid required
start_datestring date-time required

Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.

end_datestring date-time required

End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.

Example request

{
  "order_by": {
    "date": "asc"
  }
}

Response

Server-sent events stream. Emits a summary event first, then one row event per streamed row.

Changes

  • 56d428ca479fRevision changes
    • breaking

      removed subschema #1 subschema #2 from the /// request property anyOf list

    • info

      added subschema #1 subschema #2 to the /// request property anyOf list

    • info

      added the new first_cited_at enum value to the request property /

  • c55c2a1636c3Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API