citlyze docs

Aggregate Scores Resource

Export headline visibility metrics by window, brand, prompt, location, and engine.

Endpoint:

GET /api/v1/aggregate-scores

Aggregate scores power many reporting metrics.

Filters

FilterMeaning
measurement_window_idRestrict to one snapshot.
brand_idRestrict to one brand.
query_idRestrict to one prompt.
location_idRestrict to one market.
engine_idRestrict to one engine.

Key fields

  • visibility_score
  • citation_rate
  • mention_rate
  • source_rate
  • avg_prominence
  • avg_rank
  • win_rate
  • share_of_answer
  • surface_trigger_rate
  • confidence_label

If you omit measurement_window_id, the response covers the most recent completed windows within your plan's history retention. meta.history_start gives the earliest export time available to the request.

On this page