Seat Events

Get a seat event by ID

Changed on

Retrieve a seat event by its ID

get/seat-events/{id}

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/seat-events/{id}
  • Auth
    none declared. Required headers: Authorization

Path parameters

idstring required

Unique ID for this seat event

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Response

OK

idstring required

Unique ID for this seat event.

customerEventIdstring required

Unique ID provided by you. Another event with the same customer event ID will supersede this one. This ID usually corresponds to the event ID you use internally.

customerAliasstring required

End-customer alias or ID. This is a unique value provided by you and is an identifier to your customer who consumed the seats.

seatTypestring required

Seat type. This can be referenced from a seat metric.

sequenceAccountIdstring required

Unique Sequence account ID.

eventTimestampstring required

Event timestamp, in ISO 8601 format.

totalinteger required

Total seats consumed for this seat type.

Example response

{
  "id": "0184421a-8202-70ea-a729-30308a40bbf7",
  "customerEventId": "event-id-H4twuTWpYx1rkd8OMTki2hTUcZ",
  "customerAlias": "customer-id-2H4u5BBwBWsS5V2sroRFqJfTXpW",
  "seatType": "admin",
  "sequenceAccountId": "0184421e-a9cc-711b-af93-bf0511d4d833",
  "eventTimestamp": "2022-10-01T00:00:00Z",
  "total": 1
}

Changes

  • 55aec2d373b0Revision changes
    • warning

      deleted the header request parameter sequence-version

    • info

      added the new optional header request parameter Sequence-Version

  • 9c48c189e29dRevision changes
    • warning

      deleted the header request parameter Sequence-Version

    • info

      added the new optional header request parameter sequence-version