citlyze docs
API

Locations, Engines, And Brands

Export markets, AI engines, and brand records.

These resources describe the tracking dimensions used by runs and aggregate scores.

Locations

Endpoint:

GET /api/v1/locations

Filters: active, location_id.

Key fields include label, country, region, city, language, timezone, market_code, and market_importance.

Engines

Endpoint:

GET /api/v1/engines

Filter: active.

Key fields include engine_id, provider, model, weight, and active.

Engine ids cover the daily answer engines (openai_web, gemini_grounding, perplexity_sonar, deepseek_web, bytedance_seed, grok_web) and the weekly Google SERP surfaces (google_ai_overview, google_ai_mode). SERP surface runs are captured once per ISO week; their runs carry capture_method: "serp_api" and a surface_present flag indicating whether Google showed the surface for the query.

Brands

Endpoint:

GET /api/v1/brands

Brands include the target brand and competitor brand records. Key fields include brand_id, canonical_name, aliases_json, and owned_domains_json.

On this page