citlyze docs

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 (a reporting preference you control in Locations settings).

Engines

Endpoint:

GET /api/v1/engines

Filter: active.

Key fields include engine_id and active.

Engine ids cover the supported answer engines plus the Google and Bing AI search surfaces. Google surface results include a surface_present flag indicating whether the surface appeared 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