COcooper-square-technologies
Reports
Reports

Query Citations

Changed on

Get citations for a given category.

post/v1/reports/citations

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

Successful Response

Example response

{
  "data": [
    {
      "dimensions": [
        "example.com",
        "/some/path",
        "2023-10-01"
      ],
      "metrics": [
        10,
        0.05
      ]
    }
  ],
  "info": {
    "query": {
      "date_interval": "day",
      "dimensions": [
        "hostname",
        "path",
        "date"
      ],
      "filters": [
        {
          "field": "hostname",
          "operator": "is",
          "value": "example.com"
        }
      ],
      "metrics": [
        "count",
        "citation_share"
      ]
    },
    "total_rows": 200
  }
}

Changes

  • 56d428ca479fRevision changes
    • breaking

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

    • breaking

      response property data/items/metrics/items/ list-of-types was widened by adding types null and string to media type application/json of response 200

    • 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