Domains report

GET

projects

{projectId}

reports

domains

curl

curl "https://api.citino.ai/v1/projects/{projectId}/reports/domains?from=YYYY-MM-DD&to=YYYY-MM-DD" \
  -H "Authorization: Bearer $CITINO_API_KEY"

import os
import requests

res = requests.get(
    "https://api.citino.ai/v1/projects/{projectId}/reports/domains?from=YYYY-MM-DD&to=YYYY-MM-DD",
    headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
)
print(res.json())

const res = await fetch("https://api.citino.ai/v1/projects/{projectId}/reports/domains?from=YYYY-MM-DD&to=YYYY-MM-DD", {
  headers: {
    Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
  },
});
console.log(await res.json());

{
  "scope": {
    "from": "2026-11-04",
    "to": "2026-11-06",
    "engines": [
      "chatgpt",
      "google-ai-overview",
      "perplexity"
    ],
    "segments": [
      "wms"
    ],
    "prompt_scope": "category",
    "dimensions": [],
    "interval": null
  },
  "items": [
    {
      "domain": "capterra.com",
      "type": "unknown",
      "own": false,
      "retrieved": 3,
      "cited": 2,
      "answers": 4120,
      "reported_answers": 4,
      "retrieval_rate": {
        "value": 75,
        "unit": "percent",
        "band": null,
        "n": 4,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      },
      "citation_rate": {
        "value": 0,
        "unit": "percent",
        "band": null,
        "n": 4120,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "never_named"
      }
    },
    {
      "domain": "acme.example",
      "type": "unknown",
      "own": false,
      "retrieved": 1,
      "cited": 1,
      "answers": 4120,
      "reported_answers": 4,
      "retrieval_rate": {
        "value": 25,
        "unit": "percent",
        "band": null,
        "n": 4,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      },
      "citation_rate": {
        "value": 0,
        "unit": "percent",
        "band": null,
        "n": 4120,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "never_named"
      }
    }
  ],
  "next_cursor": null,
  "has_more": false
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

Authorizations

Authorization

string

header

required

An API key from Workspace settings → API keys, sent as Authorization: Bearer <key>.

Path Parameters

projectId

string

required

Query Parameters

from

string

required

First day, inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$

string

required

Last day, inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$

dimensions

string

Comma-separated: any of date, engine, segment, prompt (no prompt on the URLs report). None gives one row per brand, domain or URL for the window.

interval

enum<string>

With date: the bucket a row covers. Default day.

Available options:

day,

week,

month

engine

string[]

Engine keys (repeat the parameter or separate with commas).

segment

string[]

Claimed segment ids.

prompt

string[]

Prompt ids.

brand

string<uuid>[]

Brand ids (brands report).

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

domain

string[]

Domains (domains and URLs reports).

cursor

string

limit

integer

Required range: 1 <= x <= 200

format

enum<string>

Available options:

json,

csv

Response

scope

object

required

Show child attributes

items

object[]

required

Show child attributes

next_cursor

string | null

required

has_more

boolean

required

⌘I

curl

curl "https://api.citino.ai/v1/projects/{projectId}/reports/domains?from=YYYY-MM-DD&to=YYYY-MM-DD" \
  -H "Authorization: Bearer $CITINO_API_KEY"

import os
import requests

res = requests.get(
    "https://api.citino.ai/v1/projects/{projectId}/reports/domains?from=YYYY-MM-DD&to=YYYY-MM-DD",
    headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
)
print(res.json())

const res = await fetch("https://api.citino.ai/v1/projects/{projectId}/reports/domains?from=YYYY-MM-DD&to=YYYY-MM-DD", {
  headers: {
    Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
  },
});
console.log(await res.json());

{
  "scope": {
    "from": "2026-11-04",
    "to": "2026-11-06",
    "engines": [
      "chatgpt",
      "google-ai-overview",
      "perplexity"
    ],
    "segments": [
      "wms"
    ],
    "prompt_scope": "category",
    "dimensions": [],
    "interval": null
  },
  "items": [
    {
      "domain": "capterra.com",
      "type": "unknown",
      "own": false,
      "retrieved": 3,
      "cited": 2,
      "answers": 4120,
      "reported_answers": 4,
      "retrieval_rate": {
        "value": 75,
        "unit": "percent",
        "band": null,
        "n": 4,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      },
      "citation_rate": {
        "value": 0,
        "unit": "percent",
        "band": null,
        "n": 4120,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "never_named"
      }
    },
    {
      "domain": "acme.example",
      "type": "unknown",
      "own": false,
      "retrieved": 1,
      "cited": 1,
      "answers": 4120,
      "reported_answers": 4,
      "retrieval_rate": {
        "value": 25,
        "unit": "percent",
        "band": null,
        "n": 4,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      },
      "citation_rate": {
        "value": 0,
        "unit": "percent",
        "band": null,
        "n": 4120,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "never_named"
      }
    }
  ],
  "next_cursor": null,
  "has_more": false
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

Overview

Reference

Domains report

Authorizations

Path Parameters

Query Parameters

Response