Skip to content

Preview a delete request

POST
/teams/{teamId}/domains/{domainId}/visitor-data/preview
curl --request POST \
--url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15/visitor-data/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "value": "ada@example.com" }'

Shows what a delete request for one value from an end user’s GDPR request would erase, without erasing anything. Call it before the delete operation to check the value, or to learn that the site stores nothing about it.

How it works

The value is sent to the Blotout platform only to find the person it belongs to; it is not stored. The counts cover the whole person, not only the value sent. nothingStored: true means there is nothing to erase.

Required permissions

  • domain:visitor_data:write 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.

The value to look up.

Media typeapplication/json

The value to look up.

object
value
required

One value from the end user’s request: an anon id, a person id (gid_), an email address, a phone number in international format (leading +), or a custom id. The kind is detected from the value.

string
>= 1 characters <= 512 characters

Example

ada@example.com

What a delete request would erase, and who it would affect.

Media typeapplication/json
object
inputType
required

The kind of value the Blotout platform detected: an anon id, a person id, or an email, phone or custom id alias.

string
Allowed values: anon person email phone custom
counts
required

The identity-graph objects erased, or that a delete request would erase, by type. A second run of the same value counts only what the first one left.

object
anons
required

How many anons (browser profiles).

integer
aliases
required

How many aliases (email, phone and custom id mappings).

integer
persons
required

How many person records, 0 or 1.

integer
nothingStored
required

True when the site stores no data about the value; every count is then 0.

boolean
sharedSites
required

The sites that share this site’s identity graph through a storage link, the link parent first. The erase affects all of them. Empty when no other site shares the graph.

Array<object>

A site that shares the identity graph.

object
domainId
required

The site’s id.

string
domain
required

The site’s hostname.

string
installs
required

The app installs that would be asked to erase the person, enabled or not, on every site that shares the graph. Empty when no person or anon is stored.

Array<object>
object
appInstallId
required

The app install’s id.

string
domainId
required

The id of the site the install is on.

string
domain
required

The hostname of the site the install is on.

string
appName
required

The app’s name.

string
label
required

The install’s label.

string

Example

{
"inputType": "anon",
"counts": {
"anons": 2,
"aliases": 2,
"persons": 1
},
"nothingStored": false,
"sharedSites": [
{
"domainId": "3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15",
"domain": "shop.example.com"
}
],
"installs": [
{
"appInstallId": "7c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
"domainId": "3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15",
"domain": "shop.example.com",
"appName": "Meta Conversions",
"label": "EU pixel"
}
]
}

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. worker_outdated — The site runs a worker from before delete requests, so nothing was read or erased. Deploy the site, 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 worker_outdated

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"
}