Search events

This endpoint returns a filtered set of events for an account in a paginated list format.

Note that this is a POST endpoint rather than a GET endpoint because it employs a JSON body for search criteria rather than query parameters, allowing for a more flexible search syntax.

Note that a search criteria must be specified. Currently, Orb supports the following criteria:

• event_ids: This is an explicit array of IDs to filter by. Note that an event's ID is the idempotency_key that was originally used for ingestion.

By default, Orb will not throw a 404 if no events matched, Orb will return an empty array for data instead.

application/json

Request Body required

event_ids string[] required

Possible values: >= 1, <= 500

This is an explicit array of IDs to filter by. Note that an event's ID is the idempotency_key that was originally used for ingestion, and this only supports events that have not been amended. Values in this array will be treated case sensitively.

timeframe_start date-time nullable

The start of the timeframe, inclusive, in which to search events. If not specified, the one week ago is used.

timeframe_end date-time nullable

The end of the timeframe, exclusive, in which to search events. If not specified, the current time is used.

Responses

• 200
• 400
• 401
• 404
• 409
• 413
• 429
• 500

---

OK

Response Headers

application/json

Schema

Example (from schema)

---

Schema

data object[] required
Array [
id string required
A unique value, generated by the client, that is used to de-duplicate events. Exactly one event with a given idempotency key will be ingested, which allows for safe request retries.
customer_id string nullable required
The Orb Customer identifier
external_customer_id string nullable required
An alias for the Orb customer, whose mapping is specified when creating the customer
event_name string required
A name to meaningfully identify the action or event type.
properties object required
A dictionary of custom properties. Values in this dictionary must be numeric, boolean, or strings. Nested dictionaries are disallowed.
timestamp date-time required
An ISO 8601 format date with no timezone offset (i.e. UTC). This should represent the time that usage was recorded, and is particularly important to attribute usage to a given billing period.
deprecated boolean required
A boolean indicating whether the event is currently deprecated.
]

{
  "data": [
    {
      "id": "string",
      "customer_id": "string",
      "external_customer_id": "string",
      "event_name": "string",
      "properties": {},
      "timestamp": "2020-12-09T16:09:53Z",
      "deprecated": true
    }
  ]
}

Bad Request

Response Headers

application/json

Schema

Example (from schema)

---

Schema

oneOf
ConstraintViolationError
DuplicateResourceCreationError
RequestValidationError
---
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#400-constraint-violation]
status integer required
Possible values: [400]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation]
status integer required
Possible values: [400]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#400-request-validation-errors]
status integer required
Possible values: [400]
detail string nullable
title string nullable
validation_errors undefined[] required

{}

Unauthorized

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#401-authentication-error]

status integer required

Possible values: [401]

detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#401-authentication-error",
  "status": 401,
  "detail": "string",
  "title": "string"
}

Not Found

Response Headers

application/json

Schema

Example (from schema)

---

Schema

oneOf
FeatureNotAvailableError
ResourceNotFoundError
URLNotFound
---
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#404-feature-not-available]
status integer required
Possible values: [400]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#404-resource-not-found]
status integer required
Possible values: [404]
detail string nullable
title string required
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#404-url-not-found]
status integer required
Possible values: [404]
detail string nullable
title string nullable

{}

Conflict

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#409-resource-conflict]

status integer required

Possible values: [409]

detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#409-resource-conflict",
  "status": 409,
  "detail": "string",
  "title": "string"
}

Request Entity Too Large

Response Headers

application/json

Schema

Example (from schema)

---

Schema

oneOf
RequestTooLargeError
ResourceTooLargeError
TooManyResultsError
---
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#413-request-too-large]
status integer required
Possible values: [413]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#413-resource-too-large]
status integer required
Possible values: [413]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#413-too-many-results]
status integer required
Possible values: [413]
detail string nullable
title string nullable

{}

Too Many Requests

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#429-too-many-requests]

status integer required

Possible values: [429]

detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#429-too-many-requests",
  "status": 429,
  "detail": "string",
  "title": "string"
}

Internal Server Error

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#500-internal-server-error]

status integer required
detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#500-internal-server-error",
  "status": 0,
  "detail": "string",
  "title": "string"
}

Loading...