GET /v1/brands/{brand_id}/citations/series

Citations over time

Citations per day or week, one point per bucket and key, with every answer in the bucket so a share can be drawn. group picks the key: site_type (default; classifying while a site is not classified yet), relation, page_category, domain or url; domain and url need the keys to chart in key (repeat, up to 50). An answer with no engine recorded counts in neither its citations nor its answers, as in the answers per day and engine.

Filters compose with AND: report_id (repeat for several), scheduled_report_id, platform (repeat for several engines), date_from, date_to and category (the prompt category; repeat for several). bucket is day (default) or week, counted in tz (an IANA zone, default UTC; a week starts on Monday). Returns every point, oldest first.

Path parameters

Query parameters

  • group string (enum) optional

    What each line counts.

    one of site_type, relation, domain, page_category, url · default: site_type

  • key string optional

    Only these site types, relations, categories, domains or URLs; repeat for several.

  • bucket string (enum) optional

    day (default) or week.

    one of day, week · default: day

  • tz string optional

    IANA time zone the days and weeks are counted in, e.g. America/New_York. Default UTC.

    default: UTC

  • report_id string optional

    Only these reports (UUIDs); repeat the parameter for several.

  • report_scope string optional

    all for every completed report of the brand, in place of naming each one; the other filters still apply.

  • scheduled_report_id string optional

    Only the runs of this Scheduled Report (UUID).

  • tracker_id string optional

    Only the runs of these trackers (a report's tracker_id; a scheduled report's id is its tracker's); repeat the parameter for several.

  • market_id string optional

    Only the runs in these markets (a report's market_id, a region config's id); repeat the parameter for several.

  • place string optional

    Only the runs in these places, as country|city lowercased (united states|austin, or united states| for the whole country; country|city|region for a town keyed apart from its namesake, australia|emerald|victoria), across every tracker; repeat the parameter for several.

  • scope string optional

    default reads what the app opens on (every scheduled report's runs plus the newest one-off reports) and takes no other report, tracker, market or place filter; all reads every completed report of the brand.

  • platform string optional

    Only answers from these engines; repeat the parameter for several.

  • date_from string optional

    Only answers from this moment on (ISO-8601).

  • date_to string optional

    Only answers before this moment, exclusive (ISO-8601); not before date_from.

  • category string optional

    Only answers to prompts of these categories; repeat the parameter for several.

  • dry_run boolean optional

    Preview the call without executing it. Runs auth, scope, eligibility and body validation, then returns 200 with a dry_run object reporting the request-unit and credit cost plus a non-consuming quota snapshot. Nothing is debited, reserved, dispatched or mutated. An invalid body still returns 422.

    default: false

Responses

Citations over time application/json
Type: CitationSeries
  • data array of CitationSeriesPoint required
  • object string

    default: `list`

Example response
{
  "data": [
    {
      "answers": 64,
      "avg_position": 3.2,
      "bucket": "2026-09-20T00:00:00+00:00",
      "citation_count": 17,
      "cited_answers": 12,
      "key": "news",
      "object": "citation_series_point"
    }
  ],
  "object": "list"
}
Request validation failed application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Missing or invalid credentials application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid credentials"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
You do not have permission to access this resource application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "forbidden",
    "message": "You do not have permission to access this resource"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Resource not found application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "not_found",
    "message": "Resource not found"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Resource conflict application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "conflict",
    "message": "Resource conflict"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Per-minute rate limit exceeded application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Per-minute rate limit exceeded"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
An unexpected error occurred application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "internal_error",
    "message": "An unexpected error occurred"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Service temporarily unavailable, please retry application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "service_unavailable",
    "message": "Service temporarily unavailable, please retry"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}