Skip to main content
GET
Get Anti-Fraud Overview

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Path Parameters

shopId
integer
required

The shop ID.

Query Parameters

start
string

Start of the window. Defaults to 30 days ago.

Example:

null

end
string

End of the window. Defaults to now.

Example:

null

Body

application/json
start
string

Must be a valid date.

Example:

"2026-09-20T15:56:27"

end
string

Must be a valid date.

Example:

"2026-09-20T15:56:27"

timezone
string
Example:

null

Response

200 - application/json
window_days
integer
Example:

1

stats
object
graph
object
top_block_reasons
array
Example:
coverage
object[]
Example:
can_read_logs
boolean
Example:

true

has_risk_signals
boolean
Example:

true

risk_signals
array
Example:
suggestions
object[]
Example: