Skip to content
Zaraftis API
Esc
↑↓navigate↵open⌘Jpreview

List a scan's observations

GET/scans/{scan_id}/observations
Authorization
AuthorizationBearer token · headerrequired

API key sent as Authorization: Bearer <key>. A key belongs to one workspace, has scopes, and can be limited to some brands.

or
AuthorizationOAuth2 access token · headerrequired

OAuth 2.1 sign-in (authorization code with PKCE) used by AI assistants that connect through the Zaraftis MCP server. Discovery URLs are at https://api.zaraftis.com/api/auth.

Path parameters
scan_idstring<uuid>required
Query parameters
page_tokenstring

The next_page_token from the previous page. Send it with the same filters and limit.

limitinteger

Items per page. A route can set a lower maximum or default; its own entry says so.

min 1 · max 100 · default: 25
Responses
200

One observation list page

successbooleanrequired
dataObservationListPagerequired

One keyset page: items plus the pagination footer.

Show properties
itemsObservationItem[]required
Show properties
Array of ObservationItem
observation_idstring<uuid>required
matches ^([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)$
prompt_idstring<uuid>required
matches ^([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)$
prompt_textstringrequired
min length 1
platformstringrequired
min length 1
countrystringrequired
min length 2 · max length 2
languagestringrequired
min length 2 · max length 10
answer_typestringrequired
Allowed:normalrefusal
collected_atstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
brandobjectrequired
Show properties
mentionedbooleanrequired
citedbooleanrequired
mention_positioninteger | nullrequired
Show properties
Any of:
integer
integer
null
null
sentimentstring | nullrequired
Show properties
Any of:
string
string
null
null
mention_countintegerrequired
min 0 · max 9007199254740991
citation_countintegerrequired
min 0 · max 9007199254740991
mentionsBrandMentionItem[]required
Show properties
Array of BrandMentionItem
name_in_answerstringrequired
min length 1
brand_namestringrequired
min length 1
brand_typestringrequired
min length 1
url_in_answerstring | nullrequired
Show properties
Any of:
string
string
null
null
paginationListPaginationrequired

Cursor pagination footer. next_page_token is present only when has_more is true; the token is opaque and filter- and limit-bound.

Show properties
has_morebooleanrequired
next_page_tokenstring
min length 1
request_idstringrequired
min length 1
404

not_found: unknown id, or an id this key cannot see

successbooleanrequired
errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsobject
field_errorsobject[]
Show properties
Array of object
fieldstringrequired
codestringrequired
Allowed:requiredformattoo_smalltoo_largeunrecognized_keyinvalid
messagestringrequired
request_idRequestIdrequired
Request
curl -X GET 'https://api.zaraftis.com/v1/scans/497f6eca-6276-4993-bfeb-53cbbbba6f08/observations' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "success": true,
  "data": {
    "items": [
      {
        "observation_id": "d5b663f3-1b87-4f94-9f66-dbd8d5553132",
        "prompt_id": "24783230-27c2-455c-9de9-95bbdbb78c3d",
        "prompt_text": "string",
        "platform": "string",
        "country": "st",
        "language": "string",
        "answer_type": "normal",
        "collected_at": "2019-08-24T14:15:22Z",
        "brand": {
          "mentioned": true,
          "cited": true,
          "mention_position": 1,
          "sentiment": "string"
        },
        "mention_count": 0,
        "citation_count": 0,
        "mentions": [
          {
            "name_in_answer": "string",
            "brand_name": "string",
            "brand_type": "string",
            "url_in_answer": "string"
          }
        ]
      }
    ],
    "pagination": {
      "has_more": true,
      "next_page_token": "string"
    }
  },
  "request_id": "string"
}

Was this page helpful?