Skip to content

Read identity table rows

POST
/teams/{teamId}/domains/{domainId}/id-graph/rows
curl --request POST \
--url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15/id-graph/rows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "kind": "anon", "name": "anon_9f2c", "table": "events", "offset": 0 }'

Reads one page of a table inside an identity-graph object, so you can see the rows behind a count the inspect operation gave you.

How it works

Pages are 100 rows; advance with offset, and compare it against rowCount to know when you have read everything. found: false means the object or the table does not exist.

Required permissions

  • domain:id_graph_explorer:read on all domains, or on the addressed domain when its id is in the route
teamId
required

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

string format: uuid

Example

7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

domainId
required

Unique id (UUID) of the site, as returned by the site operations.

string format: uuid

Example

3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15

Unique id (UUID) of the site, as returned by the site operations.

Which table to page.

Media typeapplication/json

Which table of which object to page through.

object
kind
required

Which object to open: anon a browser profile, alias one identifier’s mapping, global the person an anon id or identifier resolves to.

string
Allowed values: anon alias global

Example

anon
name
required

The object name from the resolve operation.

string
>= 1 characters <= 512 characters

Example

anon_9f2c
table
required

The table to read, from the inspect operation.

string
>= 1 characters <= 128 characters

Example

events
offset

How many rows to skip.

integer
0

Example

0

The page of rows.

Media typeapplication/json
object
found
required

False when the object or the table does not exist.

boolean
columns
required

The columns, in order.

Array<string>
rows
required

The page of rows, keyed by column name.

Array<object>
object
key
additional properties
rowCount
required

How many rows the table holds in total.

integer

Example

{
"found": true,
"columns": [
"at",
"name"
],
"rowCount": 128
}

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter. invalid_body — The JSON body is unparseable or failed schema validation; details pinpoints the offending fields when the body could be parsed.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: invalid_params invalid_body
details

Field-level validation errors: a tree keyed by input property, each node carrying an errors array of human-readable messages. Render it to help the caller correct the request.

object
key
additional properties

Example

{
"error": "invalid_params",
"details": {
"errors": [],
"properties": {
"teamId": {
"errors": [
"Invalid UUID"
]
}
}
}
}

unauthenticated — The Authorization: Bearer token is missing, malformed, or no longer valid. Generate a team API token or obtain a new OAuth access token.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: unauthenticated

Example

{
"error": "unauthenticated"
}

forbidden — The bearer credential lacks the required permission or belongs to another team, or its user lacks the organization role a developer operation needs. Update its policies, use a credential bound to the addressed team, or ask an organization owner for the role; message states the reason when one is known.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: forbidden
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
"error": "forbidden",
"message": "The Cloudflare API token is invalid or expired."
}

not_found — The addressed resource does not exist within this team; check the id and retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: not_found

Example

{
"error": "not_found"
}

not_deployed — The site has never been deployed, so it has no host to describe yet. Deploy it, then retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: not_deployed

Example

{
"error": "not_deployed"
}

host_not_ready — The site’s host is not ready to serve it — no Cloudflare zone chosen, no stored API token, a token scoped to the wrong zone, a conflicting DNS record, or a dispatcher that refused the request. message names the fix.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: host_not_ready
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
"error": "host_not_ready",
"message": "The Cloudflare API token is invalid or expired."
}

internal — Unexpected server error. Nothing is guaranteed to have been persisted; idempotent operations are safe to retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: internal

Example

{
"error": "internal"
}

worker_unreachable — The site’s own worker could not be reached or refused the request, so nothing could be read from it; message says what failed. Retry once the site is serving again.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: worker_unreachable

Example

{
"error": "worker_unreachable"
}