Skip to main content
GET
Get alert data with deals

Authorizations

Authorization
string
header
required

API key provided as a Bearer token

Query Parameters

alert_ids
string
required

Comma-separated list of alert UUIDs (up to 10 alerts per request). All alerts must be associated with your API key's account. Example: "uuid1,uuid2,uuid3"

Example:

"550e8400-e29b-41d4-a716-446655440000,660e8400-e29b-41d4-a716-446655440001"

start_date
string<date-time>
required

Start date for the alert data range (ISO 8601 format). Results will include deals from this date onwards.

Example:

"2024-01-01T00:00:00.000Z"

end_date
string<date-time>
required

End date for the alert data range (ISO 8601 format). Results will include deals up to and including this date.

Note: All dates are processed in UTC timezone. Deals are grouped into time periods based on UTC date boundaries.

Example:

"2024-12-31T23:59:59.999Z"

Response

Successful response with alert data organized by time periods

success
boolean
required
Example:

true

data
object
required
meta
object
required