Measure tracked coverage citation evidence

curl --request GET \
  --url https://app.chatobserver.com/api/v2/coverage/measurement \
  --header 'x-chatobserver-key: <api-key>'

const options = {method: 'GET', headers: {'x-chatobserver-key': '<api-key>'}};

fetch('https://app.chatobserver.com/api/v2/coverage/measurement', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "definitionVersion": "coverage-observations-v2",
    "capturedAt": "2023-11-07T05:31:56Z",
    "scope": {
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "attribution": "all",
      "cohort": "all",
      "interval": "week",
      "coverageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "search": "<string>",
      "archived": true,
      "rootDomain": "<string>",
      "promptId": "<string>",
      "groupId": "<string>",
      "platform": "chatgpt",
      "region": "<string>"
    },
    "previousRange": {
      "startDate": "2023-12-25",
      "endDate": "2023-12-25"
    },
    "current": {
      "answers": 1,
      "assessed": 1,
      "citing": 1,
      "brandAssessed": 1,
      "brandMentioned": 1,
      "citationRate": 0.5,
      "visibilityRate": 0.5
    },
    "previous": {
      "answers": 1,
      "assessed": 1,
      "citing": 1,
      "brandAssessed": 1,
      "brandMentioned": 1,
      "citationRate": 0.5,
      "visibilityRate": 0.5
    },
    "population": {
      "currentCells": 1,
      "previousCells": 1,
      "sharedCells": 1,
      "currentAnswers": 1,
      "previousAnswers": 1
    },
    "trend": [
      {
        "answers": 1,
        "assessed": 1,
        "citing": 1,
        "brandAssessed": 1,
        "brandMentioned": 1,
        "citationRate": 0.5,
        "visibilityRate": 0.5,
        "date": "2023-12-25",
        "endDate": "2023-12-25"
      }
    ],
    "previousTrend": [
      {
        "answers": 1,
        "assessed": 1,
        "citing": 1,
        "brandAssessed": 1,
        "brandMentioned": 1,
        "citationRate": 0.5,
        "visibilityRate": 0.5,
        "date": "2023-12-25",
        "endDate": "2023-12-25"
      }
    ],
    "items": [
      {
        "url": "<string>",
        "title": "<string>",
        "publisher": "<string>",
        "publishedOn": "2023-12-25",
        "medium": "article",
        "attribution": "unclassified",
        "notes": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "version": 2,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "archivedAt": "2023-11-07T05:31:56Z",
        "citingAnswers": 1,
        "previousCitingAnswers": 1
      }
    ],
    "itemPageInfo": {
      "page": 2,
      "pageSize": 20,
      "total": 1,
      "hasMore": true
    },
    "evidence": {
      "answerCount": 123,
      "firstObservedAt": "2023-11-07T05:31:56Z",
      "lastObservedAt": "2023-11-07T05:31:56Z",
      "page": 123,
      "pageSize": 123,
      "answers": [
        {
          "responseId": "<string>",
          "promptId": "<string>",
          "promptLabel": "<string>",
          "completedAt": "2023-11-07T05:31:56Z",
          "platform": "chatgpt",
          "regionCode": "<string>",
          "sourceUrl": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "requestId": "<string>"
}

Tracked coverage

Measure tracked coverage citation evidence

Measure the same coverage-observations-v2 populations as the dashboard. Supply an inclusive UTC calendar range of at most 366 days; comparison uses the preceding equal-length range. Cohort shared restricts observations to prompt/platform/region cells present in both periods. Citation and brand assessment denominators remain distinct; absent assessments return null rates, not zero. These observations do not establish causation. Items and citation evidence paginate independently, 20 per page. Each request has one database snapshot; later pages may reflect later changes. Requires Sources and coverage availability. Delegated MCP connections require coverage:read.

GET

api

coverage

measurement

Measure tracked coverage citation evidence

curl --request GET \
  --url https://app.chatobserver.com/api/v2/coverage/measurement \
  --header 'x-chatobserver-key: <api-key>'

const options = {method: 'GET', headers: {'x-chatobserver-key': '<api-key>'}};

fetch('https://app.chatobserver.com/api/v2/coverage/measurement', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "definitionVersion": "coverage-observations-v2",
    "capturedAt": "2023-11-07T05:31:56Z",
    "scope": {
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "attribution": "all",
      "cohort": "all",
      "interval": "week",
      "coverageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "search": "<string>",
      "archived": true,
      "rootDomain": "<string>",
      "promptId": "<string>",
      "groupId": "<string>",
      "platform": "chatgpt",
      "region": "<string>"
    },
    "previousRange": {
      "startDate": "2023-12-25",
      "endDate": "2023-12-25"
    },
    "current": {
      "answers": 1,
      "assessed": 1,
      "citing": 1,
      "brandAssessed": 1,
      "brandMentioned": 1,
      "citationRate": 0.5,
      "visibilityRate": 0.5
    },
    "previous": {
      "answers": 1,
      "assessed": 1,
      "citing": 1,
      "brandAssessed": 1,
      "brandMentioned": 1,
      "citationRate": 0.5,
      "visibilityRate": 0.5
    },
    "population": {
      "currentCells": 1,
      "previousCells": 1,
      "sharedCells": 1,
      "currentAnswers": 1,
      "previousAnswers": 1
    },
    "trend": [
      {
        "answers": 1,
        "assessed": 1,
        "citing": 1,
        "brandAssessed": 1,
        "brandMentioned": 1,
        "citationRate": 0.5,
        "visibilityRate": 0.5,
        "date": "2023-12-25",
        "endDate": "2023-12-25"
      }
    ],
    "previousTrend": [
      {
        "answers": 1,
        "assessed": 1,
        "citing": 1,
        "brandAssessed": 1,
        "brandMentioned": 1,
        "citationRate": 0.5,
        "visibilityRate": 0.5,
        "date": "2023-12-25",
        "endDate": "2023-12-25"
      }
    ],
    "items": [
      {
        "url": "<string>",
        "title": "<string>",
        "publisher": "<string>",
        "publishedOn": "2023-12-25",
        "medium": "article",
        "attribution": "unclassified",
        "notes": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "version": 2,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "archivedAt": "2023-11-07T05:31:56Z",
        "citingAnswers": 1,
        "previousCitingAnswers": 1
      }
    ],
    "itemPageInfo": {
      "page": 2,
      "pageSize": 20,
      "total": 1,
      "hasMore": true
    },
    "evidence": {
      "answerCount": 123,
      "firstObservedAt": "2023-11-07T05:31:56Z",
      "lastObservedAt": "2023-11-07T05:31:56Z",
      "page": 123,
      "pageSize": 123,
      "answers": [
        {
          "responseId": "<string>",
          "promptId": "<string>",
          "promptLabel": "<string>",
          "completedAt": "2023-11-07T05:31:56Z",
          "platform": "chatgpt",
          "regionCode": "<string>",
          "sourceUrl": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "requestId": "<string>"
}

Required scopes: read.

Authorizations

x-chatobserver-key

string

header

required

A workspace API key. Data endpoints require a service-account key with the specified scopes.

Query Parameters

startDate

string<date>

required

endDate

string<date>

required

attribution

enum<string>

default:all

Available options:

all,

our_team,

external,

unclassified

cohort

enum<string>

default:all

Available options:

shared,

all

interval

enum<string>

default:week

Available options:

day,

week

coverageId

string<uuid>

string

Maximum string length: 200

archived

enum<string>

Available options:

true,

false

rootDomain

string

Maximum string length: 253

promptId

string

Pattern: ^prm_[1-9][0-9]*$

groupId

string

Pattern: ^tag_[1-9][0-9]*$

platform

enum<string>

Supported product platform identifier.

Available options:

chatgpt,

ai_overview,

ai_mode,

gemini,

perplexity,

claude

region

string

Required string length: 1 - 64

evidencePage

integer

default:1

Required range: 1 <= x <= 100000

itemsPage

integer

default:1

Required range: 1 <= x <= 100000

evidenceStart

string<date>

evidenceEnd

string<date>

Response

Successful result.

data

object

required

Show child attributes

Integration guides

Endpoint reference

Measure tracked coverage citation evidence

Authorizations

Query Parameters

Response