Admin api sessions
List sessions
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
minCreatedAt?string
Format
date-timemaxCreatedAt?string
Format
date-timeminUpdatedAt?string
Format
date-timemaxUpdatedAt?string
Format
date-timecount?integer
Number of results
Default
20Range
value <= 200after?string
Id or base64 encoded cursor(id + sortKey)
before?string
Id or base64 encoded cursor(id + sortKey)
orderBy?string
The sort key, sorting by id by default
Value in
"id" | "code" | "storeId" | "visitors" | "groupSize" | "expiresAt" | "customerId" | "storeId" | "codeLastSuccesfullyScannedAt" | "customerLastEnteredAt" | "createdAt" | "updatedAt"direction?string
Direction of sorting
Value in
"asc" | "desc"id?integer
code?string
sessionToken?string
storeId?integer
customerId?integer
status?array<>
minVisitors?integer
Range
0 <= valuemaxVisitors?integer
Range
1 <= valueminGroupSize?integer
Range
0 <= valuemaxGroupSize?integer
Range
1 <= valueminExpiresAt?string
Format
date-timemaxExpiresAt?string
Format
date-timeminCodeLastSuccesfullyScannedAt?string
Format
date-timemaxCodeLastSuccesfullyScannedAt?string
Format
date-timeminCustomerLastEnteredAt?string
Format
date-timemaxCustomerLastEnteredAt?string
Format
date-timeResponse Body
application/json
application/json
curl -X GET "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/sessions?minCreatedAt=2024-09-22T00%3A00%3A00.000Z&maxCreatedAt=2024-09-29T00%3A00%3A00.000Z&minUpdatedAt=2024-09-23T00%3A00%3A00.000Z&maxUpdatedAt=2024-09-30T00%3A00%3A00.000Z"{
"data": [
{
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"code": "c69bb289-1190-4156-b9f6-bfb7f61e85db",
"codeFirstSuccesfullyScannedAt": "2019-08-24T14:15:22Z",
"codeLastSuccesfullyScannedAt": "2019-08-24T14:15:22Z",
"customerFirstEnteredAt": "2019-08-24T14:15:22Z",
"customerLastEnteredAt": "2019-08-24T14:15:22Z",
"customerFirstExitedAt": "2019-08-24T14:15:22Z",
"customerLastExitedAt": "2019-08-24T14:15:22Z",
"customerPaymentInstrumentId": 0,
"customerSatisfaction": 95,
"customerSatisfactionSubmitted": false,
"groupSize": 0,
"visitors": 0,
"locationId": "string",
"priority": 0,
"sessionToken": "d3a00526-1864-4f6e-bb2d-46e3ab7fa780",
"sessionId": "d3a00526-1864-4f6e-bb2d-46e3ab7fa780",
"referencedSessionId": null,
"status": "active",
"storeId": 0,
"storeIdScannableAt": 0,
"suspectedFraud": false,
"metadata": {
"events": [
{
"eventId": "6bdbfb2d-65b2-491c-bc97-c0ac73338476",
"metadata": {
"key": "value"
}
}
],
"exampleKey": "exampleValue"
},
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"customerId": "string",
"customer": {
"externalId": "string",
"role": "customer",
"metadata": {
"arbitraryKey": "arbitraryValue"
},
"priority": 0,
"email": "user@example.com",
"firstName": "string",
"lastName": "string",
"phone": "string",
"id": "string"
},
"store": {
"aifiUniqueStoreId": "string",
"status": "OPEN",
"deploymentStatus": "LIVE",
"addressLine1": "string",
"addressCity": "string",
"addressRegion": "string",
"addressCountry": "AC",
"addressPostalCode": "string",
"thirdPartyId": "string",
"storeUrl": "string",
"maxPeople": 0,
"storeConfigId": 0,
"name": "string",
"id": "string",
"employeeInside": true
}
}
],
"pagination": {
"previous": {
"count": 0,
"before": "string",
"direction": "asc"
},
"next": {
"count": 0,
"after": "string",
"direction": "asc"
}
}
}Empty
{
"message": "Invalid request body",
"type": "E_INVALID_BODY",
"errors": [
{
"error": "\"email\" is required",
"rule": "any.required",
"field": "\"email\""
}
]
}How is this guide?