BI Tools

The REST API is designed for read-only reporting exports.

Power BI

1. Choose Get data.
2. Choose Web.
3. Paste the API URL.
4. Add the Authorization header in advanced options.
5. Use JSON or CSV depending on your model.

Example URL:

https://app.citlyze.com/api/v1/aggregate-scores?format=csv

Looker Studio

Citlyze ships a community connector that feeds Looker Studio directly from the API through a purpose-built row endpoint, so no client-side joins are needed. Twelve dimensions (date, brand and brand name, engine, prompt and prompt text, topic, market, domain, URL, source classification, and the measurement window) and ten metrics: visibility score, mention rate, citation rate, share of answer, average prominence, Net Sentiment Score, runs, citations, AI referral sessions, and AI crawler visits.

Fields resolve to one of four views per chart: visibility scores, cited sources, AI referral sessions, or AI crawler visits. Use fields from one view per chart. Results are cached for an hour per field set and date range.

Works on plans with API export and on Agency Studio, which includes Looker Studio export. Create an API key in workspace settings.

1. Download the connector: citlyze-looker-studio-connector.zip (contains Code.gs and appsscript.json).
2. Open script.new to create a Google Apps Script project, and replace the default Code.gs with the one from the download.
3. In Project Settings, enable Show "appsscript.json" manifest file, and replace its contents with the appsscript.json from the download.
4. Choose Deploy → Test deployments and copy the Head deployment ID.
5. In Looker Studio, create a data source, pick Build your own under community connectors, and paste the deployment ID.
6. Authorize the script, then paste your Citlyze API key (aeo_live_...) when prompted.

The connector requires a date range; add a date-range control to scope reports. Optional config fields set a default brand or engine filter for a data source. Rate averages weight rows equally, so for run-weighted math, blend with the n_runs metric.

Row limits

A single request returns at most 20,000 rows. When a result reaches that limit, the response reports it so you can tell a partial answer from a complete one:

{
  "view": "citations",
  "rows": [],
  "meta": { "workspace_id": "...", "truncated": true, "row_limit": 20000 }
}

If truncated is true, narrow the date range or request fewer fields and run the report again. The connector writes a warning to the Apps Script execution log in the same situation.

Starter report layout

A working starter report takes four charts, one view each:

1. Time series: Date + Visibility score, broken down by Brand.
2. Table: Prompt, Topic, Engine + Visibility score and Citation rate.
3. Table: Domain, Source classification + Citations.
4. Time series: Date + AI referral sessions and AI crawler visits (two charts, one metric each).

If you prefer not to use Apps Script, any connector that supports custom headers works against the CSV endpoints, or schedule API exports into a Google Sheet first.

Google Sheets

For one-off analysis, download CSV from any endpoint:

curl "https://app.citlyze.com/api/v1/citations?format=csv" \
  -H "Authorization: Bearer aeo_live_..." \
  -o citations.csv

For scheduled updates, use a script or connector that can set the Authorization header.

Modeling tips

• Start with measurement-windows, prompts, brands, and aggregate-scores.
• Add runs and brand-detections when you need answer-level evidence.
• Add citations and sources for source analysis.