Skip to main content
POST
Submit Fraud Labels for an event

Authorizations

Authorization
string
header
required

Add your Secret API Key to the Authorization header using the standard Bearer format: Authorization: Bearer <secret_api_key>

Body

application/json

Submits labels for a single event, processed synchronously.

event_id
string
required

The event ID being labelled. Must be no more than 30 days old.

Example:

"1735401600000.AbCdEf"

labels
object[]
required

The list of labels to submit. A label may appear only once.

Minimum array length: 1

Response

OK. The labels were stored, or the event already had them.

The result of a synchronous label submission.

source_id
string
required

The ID of this submission.

Example:

"1786370416667.4gsLK5"

source_type
string
required

The type of this submission.

Example:

"server_api"

event_id
string
required

The event ID that was labelled.

Example:

"1735401600000.AbCdEf"

status
enum<string>
required

The result of labelling the event:

  • applied - The labels were stored, changing the event's labelled state.
  • unchanged - The event's labelled state already matched every submitted label, nothing was changed.
  • rejected - The labels could not be stored, and the event's labelled state is unchanged. See errors.
Available options:
applied,
unchanged,
rejected
Example:

"applied"

errors
object[]

The reasons the labels were rejected. Omitted unless status is rejected.