Raw schema
{
"type": "object",
"properties": {
"event_occurred_on_or_after": {
"description": "Only events on or after this time (UTC).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,7})?)?(Z|[+-]\\d{2}:?\\d{2})?)?$"
},
"event_occurred_on_or_before": {
"description": "Only events on or before this time (UTC).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,7})?)?(Z|[+-]\\d{2}:?\\d{2})?)?$"
},
"events": {
"description": "Only these event types.",
"minItems": 1,
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"enum": [
"OrderPlaced",
"GiftCardCreated",
"CreditAdded",
"Redeemed",
"Expired",
"Unexpired",
"Voided",
"Reactivated"
]
}
},
"users": {
"description": "Only events generated by these user email addresses.",
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"locations": {
"description": "Only events at these location ids (see giftup_list_locations).",
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9-]{1,64}$",
"description": "The id (a GUID)."
}
},
"code": {
"description": "Only events of the gift card with this code.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"offset": {
"description": "Results to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"test_mode": {
"description": "Read the account's test data instead of live data (sends x-giftup-testmode: true). Default false.",
"type": "boolean"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}