Roambee
API docs by Redocly

Roambee API (V2)

Download OpenAPI specification:Download

Roambee Support: support@roambee.com URL: https://www.roambee.com/contact/

Roambee APIs give access to the IOT platform and the management of devices and shipments.

General principles

  • An API key needs to be used as a way to authenticate. Ask our customer success team to provide you with one.
  • It should be set in the header with the name apikey.
  • We only support TLS 1.2.

API calling limit:

  • 5 requests in 1 sec
  • Maximum 10k API requests per day.

Endpoints for portals:

To get UUIDs

  • User can get a list of shipments/assets from the APIs (get list of shipments, get list of assets) where all details will be returned in a response, including the uuid.

Allowed HTTP methods and response codes

Allowed HTTP methods Functionality
GET Retrieves a resource or list of resources
PUT Updates a resource
POST Creates a resource or list of resources
DELETE Deletes a resource
Server Responses
200 Ok The request was succesful
201 Created Entity was created
400 Bad Request The request could not be understood or was missing required parameters
401 Unauthorized Authentication failed
403 Forbidden Access denied
404 Not Found Resource was not found
500 Internal Server Error Generic error when server has a malfunction

Shipment

Create Shipment

Create a new shipment by passing values to the parameters.

header Parameters
apiKey
required
string

Key to authenticate

Request Body schema: application/json

It includes all details regarding the shipment and device attached to it.

name
required
string

Name of the shipment

description
string

Shipment description

origin
required
string

Origin location name from the list of saved locations in your account. If location is not already saved, refer to example "Shipment when locations are not created on portal".

destination
required
string

Destination location name from the list of saved locations in your account. If location is not already saved, refer to example "Shipment when locations are not created on portal".

scheduled_departure
required
number

Unix Epoch Timestamp in seconds

scheduled_arrival
required
number

Unix Epoch Timestamp in seconds

isSingleBeeShipment
boolean

There are two types of shipments. Sensor-based and non-sensor shipments. This field is mandatory while creating sensor based shipment. Set true -> To create a single bee shipment; If set false/or if not provided -> To create a multibee shipment. By default user will be eligible to create sensor based shipment. To enable non-sensor shipment creation feature, please contact Roambee admin.

Array of objects

There are two types of shipments. Sensor-based and non-sensor shipments. This field is mandatory while creating sensor based shipment. By default user will be eligible to create sensor based shipment. Give details about the bees attached to the shipment. User can either give bee name or imei. To enable non-sensor shipment creation feature, please contact Roambee admin.

Array of objects

List of BLE devices on the shipment. Please mention device IMEI. This field is applicable for a sensor based shipment.

bleShipment
boolean

true -> the shipment includes any beacon or asset; If set false/or if not provided -> BLE shipment will be not created.

object

Details about custom fields related to the shipment. For example, quick starting a shipment.

object

It will include all fields which are mentioned in Admin > Account > Shipment Custom Fields. The name of the field should be the same as how it is saved in the account. These fields are the same that are mentioned under device configurations > global properties on the portal. Here are some sample fields.

Array of objects

List of waypoints details. If waypoint location is already created on portal then only name is required as shown in example "Shipment with Single Waypoint(when waypoint location already exists on portal)" otherwise please refer to the following object.

Array of objects

Details to configure ocean or air routes.

subscriptions
Array of objects

User email id. User must be an existing user on portal, otherwise they will not be added.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "shipment1",
  • "origin": "Ahmedabad RB office",
  • "destination": "Sidi saiyed ahmedabad",
  • "scheduled_departure": 1697003217,
  • "scheduled_arrival": 1697048999,
  • "isSingleBeeShipment": true,
  • "bees": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "response": [
    ],
  • "public_tracking_url": "https://view-staging.roambee.com/track/PaKE5RQ"
}

Edit Shipment

It will edit the existing shipment. Similar to create shipment, you need to pass JSON containing all the required parameters as well as the parameters whose values need to be updated.

query Parameters
uuid
required
string <UUID>

Shipment unique identifier

header Parameters
apiKey
required
string

Key to authenticate

Request Body schema: application/json

It includes all details of the shipment.

name
required
string

Name for the shipment

description
string

Shipment description

origin
required
string

Origin location name from the list of saved locations in your account. If there are any changes in the origin location, the configured route will be reset.

destination
required
string

Destination location name from the list of saved locations in your account. If there are any changes in the destination location, the configured route will be reset.

scheduled_departure
required
number

Unix Epoch Timestamp in seconds

scheduled_arrival
required
number

Unix Epoch Timestamp in seconds

isSingleBeeShipment
boolean

There are two types of shipments. Sensor-based and non-sensor shipments. This field is mandatory while creating sensor based shipment. Set true -> For a single bee shipment; set false -> For a multibee shipment. By default user will be eligible to create sensor based shipment. To enable non-sensor shipment creation feature, please contact Roambee admin.

Array of objects

There are two types of shipments. Sensor-based and non-sensor shipments. This field is mandatory while creating sensor based shipment. By default user will be eligible to create sensor based shipment. Give details about the bees attached to the shipment. User can either give bee name or imei. To enable non-sensor shipment creation feature, please contact Roambee admin. A non-sensor shipment can be converted to sensor based by specifying bee/s while editing the shipment.

Array of objects

List of BLE devices on the shipment. Please mention device IMEI. This field is applicable for a sensor based shipment.

bleShipment
boolean

Set true -> the shipment includes any beacon or asset; If set false/or if not provided -> BLE shipment will be not created.

object

Details about custom fields related to the shipment. For example, quick start shipment.

shipment_properties
object

It will include all fields which are mentioned in the account under Shipment Custom Fields. The name of the field should be the same as how it is saved in the account. These fields are the same that are mentioned under global properties of device configurations on the portal. Here are some sample fields.

Array of objects

List of waypoints details. If waypoint location is already created on portal then only name is required otherwise please refer to the following object. If there are any changes in the waypoint location, the configured route will be reset.

multi_model
Array of arrays

Details to configure ocean or air routes. If there are any changes in the Multi-model Departure or Arrival ports, the configured route will be reset.

subscriptions
Array of arrays

User email ids

Responses

Request samples

Content type
application/json
{
  • "name": "Shipment",
  • "description": "Edited description",
  • "origin": "Ahmedabad RB office",
  • "destination": "Pune",
  • "scheduled_departure": 1707360993,
  • "scheduled_arrival": 1707382593,
  • "isSingleBeeShipment": false,
  • "bees": [
    ]
}

Response samples

Content type
application/json
{
  • "unallocatedBees": [ ],
  • "response": {
    },
  • "public_tracking_url": "https://view-staging.roambee.com/track/0OBXCIn"
}

Get List of Shipments

On passing the condition under the filter, it will return all shipment details based on the filter condition. Different supported operators are

  1. eq → Exact match with field
  2. ne → Exact match with field for not equals
  3. has → Regexp match with field
  4. gt → Greater than
  5. gte → Greater than or equal to
  6. lt → Less than
  7. lte → Less than or equal to
  8. and → AND matching between two or more fields
  9. or → OR matching between two or more fields

query Parameters
$filter
string
Examples:
  • $filter=account_name eq 'Roambee' -
  • $filter=created_date_timestamp gt 1631069132000 -
  • $filter=bee_name eq 'RD Acc bee 132' -
  • $filter=shipment_name has 'testing' and origi_location_name eq 'Mumbai' -
  • $filter=account_name eq 'Roambee' and beacon_enabled eq 1 -

Search condition. Few fields that you can filter on are

  1. shipment_name (Name)
  2. account_name (Account)
  3. bee_name (Bee Name)
  4. bee_imei (Bee IMEI)
  5. orgi_location_name (Origin)
  6. desti_location_name (Destination)
  7. created_date_timestamp (Created Date)
  8. beacon_enabled (Beacon)

Refer examples for more details. Other than these fields, you can also use the fields that are in the response of the API.

$size
number
Examples:
  • $size=5 -

This specifies result count. If not specified by default it will return 10 records. Maximum value can be 100. For more please use pagination.

$offset
number

Offset from start of records. Calculated as (desired_page_num - 1) * size

$fields
string
Examples:
  • $fields=all -

Fetch the fields

header Parameters
apiKey
required
string

Key to authenticate

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "size": 1,
  • "total": 34,
  • "data": [
    ]
}

Terminate Shipment

It will terminate the shipment.

query Parameters
uuid
required
string <UUID>

Shipment unique identifier

header Parameters
apiKey
required
string

Key to authenticate

Request Body schema: application/json

It will terminate the shipment.

reason
string

Give reason for termination

Responses

Request samples

Content type
application/json
{
  • "uuid": "723c09c3-fc17-4dad-9795-7214e4f0e5f6",
  • "reason": "shipment complete"
}

Response samples

Content type
application/json
{ }

Get Shipment Details

It will return all details of that particular shipment in JSON format.

query Parameters
uuid
required
string <UUID>

Shipment unique identifier

header Parameters
apiKey
required
string

Key to authenticate

Responses

Response samples

Content type
application/json
{
  • "name": "Test shipment",
  • "active": 1,
  • "parent_shipment": null,
  • "use_dynamic_waypoints": null,
  • "description": "nul",
  • "scheduled_arrival": 1712660400,
  • "scheduled_departure": 1712448000,
  • "actual_arrival": 0,
  • "actual_departure": 0,
  • "origin": {
    },
  • "destination": {
    },
  • "waypoints": [ ],
  • "subscriptions": [ ],
  • "manual_start": null,
  • "created_date": 1712237431,
  • "flexi_start_rule": false,
  • "gsm_start_rule": false,
  • "tracking_type": "live",
  • "shipment_properties": {
    },
  • "multi_modal_source": "multi_modal",
  • "ocean_tracking_data": {
    },
  • "account_id": 2001,
  • "report": { },
  • "custom_data": {
    },
  • "bees": [
    ],
  • "geo_summary": {
    },
  • "sensor_summary": { }
}

Get MKT Details

Mean Kinetic Temperature (MKT) is a single temperature that accounts for the cumulative effect of numerous temperature variations over a period of time. It returns a list of all MKT values with timestamps.

query Parameters
uuid
required
string <UUID>

Shipment unique identifier

header Parameters
apiKey
required
string

Key to authenticate

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Alert for Shipment

It returns a list of all alerts for the shipment. Each item in the list contains all information pertaining to an alert. For example, bee state, short message, event, etc.

header Parameters
apiKey
required
string

Key to authenticate

Request Body schema: application/json

It returns a list of all alerts for the shipment. Each item in the list contains all information pertaining to an alert. For example, bee state, short message, event, etc.

sid
required
string

Shipment unique identifier

Responses

Request samples

Content type
application/json
{
  • "sid": "723c09c3-fc17-4dad-9795-7214e4f0e5f6"
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Terminate Shipment Deprecated

It will terminate the shipment.

query Parameters
sid
required
string <UUID>

Shipment unique identifier

reason
string

Give reason for termination

email
required
string

User Email-id

header Parameters
apiKey
required
string

Key to authenticate

Responses

Response samples

Content type
application/json
{ }

Get Shipment templates

It will return all saved templates in your account.

header Parameters
apiKey
required
string

Key to authenticate

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bee

Get Bee Messages

Returns a list of all messages for a given bee and for the mentioned duration.

query Parameters
bid
required
string

Unique identifier for the bee(IMEI number)

start
number

Unix Epoch Timestamp in seconds

end
number

Unix Epoch Timestamp in seconds

days
number

Give the number of days

active
number

Either 1 or 0

header Parameters
apiKey
required
string

Key to authenticate

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all Bees

Returns all bees for a given account

query Parameters
active
number

Either 1 or 0

offset
required
number

Start offset

limit
required
number

Number of results

header Parameters
apiKey
required
string

Key to authenticate

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "count": "185164,",
  • "next_offset": 2
}

Search Bees

On passing the condition under a filter, it will return all bees based on the filter condition. Different supported operators are;

  1. eq → Exact match with field
  2. ne →Exact match with field for not equals
  3. has → Regexp match with field
  4. gt → Greater than
  5. gte → Greater than or equal to
  6. lt → Less than
  7. lte → Less than or equal to
  8. and → AND matching between two or more fields
  9. or → OR matching between two or more fields

query Parameters
$filter
string
Examples:
  • $filter=communication eq 'OK' -
  • $filter=bee_name eq 'RCR13938' -
  • $filter=account_name eq 'IFCO' -
  • $filter=created_date eq 1613377504 -
  • $filter=device_type has 'BeeSense' and active eq 1 -

Search condition. Few fields that you can filter on are

  1. device_type (Type)
  2. bee_number (Bee Number)
  3. bee_name (Bee Name)
  4. imei
  5. active

Refer examples for more details. Other than these fields, you can also use the fields that are in the response of the API.

$size
number

This specifies result count. If not specified by default it will return 10 records. Maximum value can be 100. For more please use pagination.

$offset
number

Offset from start of records. Calculated as (desired_page_num - 1) * size

$fields
string
Examples:
  • $fields=all -

Fetch the fields

header Parameters
apiKey
required
string

Key to authenticate

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "size": 2,
  • "total": 2,
  • "data": [
    ]
}

Location

Get all location Details

It will return all the saved locations from the account.

query Parameters
limit
number

Number of results

offset
number

Start offset

aid
number

Account number

header Parameters
apiKey
required
string

Key to authenticate

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "count": "131,",
  • "next_offset": 3
}

Add a new location

Save location details to your account

header Parameters
apiKey
required
string

Key to authenticate

Request Body schema: application/json
name
required
string

Name for the location

is_start_point
number

Either 0 or 1. If nothing is provided, default value will be 0.

data
required
string

Containing all the details about the location. Structure for this will be "Stringify JSON".

users
Array of arrays

List of user ids

static_geo
boolean

Indicates whether the location is mapped to a beacon. Mandatory to be passed true if the mapping is needed. Pass false if you don't want mapping or want to disable existing one.

entity_type
string

Mandatory to be passed as 'Location' if mapping with a beacon is required.

mapping_type
string

Mandatory if mapping with beacon is required. Pass 'Wi-Fi' if mapping with a mac address and 'BLELocation' if mapping with a beacon.

mac_address
string

Mandatory if mapping with beacon is required. It refers to the mac address to which this location is to be mapped.

bee_id
number

Mandatory if mapping with beacon is required. It refers to the id of bee of type "LocationBeacon" to which this location is to be mapped.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Magarpatta city",
  • "is_start_point": 0,
  • "data": "{\"name\":\"Magarpatta city\",\"address\":\"Magarpatta City,Hadapasar, Pune\",\"detailed_name\":\"Magarpatta city\",\"radius\":4000,\"hub\":0,\"port\":0,\"is_dynamic_waypoint\":1,\"geo\":{\"address\":\"Magarpatta City,Hadapasar, Pune\",\"radius\":4000,\"lat\":18.5158057,\"lng\":73.9271644},\"shape\":{\"data\":{\"center\":{\"lat\":18.5158057,\"lng\":73.9271644},\"radius\":4000},\"type\":\"circle\"}}",
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "trial add loc via API",
  • "account_id": 1,
  • "is_start_point": 0,
  • "uuid": "42828770-ad49-4ef9-a7dc-7c0eab1c4135",
  • "id": 31128,
  • "data": {
    }
}

Modify existing location

To modify the exsiting location saved in the account. Similar to add location, user need to pass JSON containing all the required parameters as well as the parameters whose values need to be updated in the same way as given in add location.

query Parameters
lid
required
string

Location uuid

header Parameters
apiKey
required
string

Key to authenticate

Request Body schema: application/json
name
required
string

Name for the location

is_start_point
number

Either 0 or 1.

data
required
string

Containing all the details about the location. Structure for this will be "Stringify JSON".

users
Array of arrays

List of user ids

static_geo
boolean

Indicates whether the location is mapped to a beacon. Mandatory to be passed true if the mapping is needed. Pass false if you don't want mapping or want to disable existing one.

entity_type
string

Mandatory to be passed as 'Location' if mapping with a beacon is required.

mapping_type
string

Mandatory if mapping with beacon is required. Pass 'Wi-Fi' if mapping with a mac address and 'BLELocation' if mapping with a beacon.

mac_address
string

Mandatory if mapping with beacon is required. It refers to the mac address to which this location is to be mapped.

bee_id
number

Mandatory if mapping with beacon is required. It refers to the id of bee of type "LocationBeacon" to which this location is to be mapped.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Magarpatta city",
  • "is_start_point": 0,
  • "data": "{\"name\":\"Magarpatta city\",\"address\":\"Magarpatta City,Hadapasar, Pune\",\"detailed_name\":\"Magarpatta city\",\"radius\":4000,\"hub\":0,\"port\":0,\"is_dynamic_waypoint\":1,\"geo\":{\"address\":\"Magarpatta City,Hadapasar, Pune\",\"radius\":4000,\"lat\":18.5158057,\"lng\":73.9271644},\"shape\":{\"data\":{\"center\":{\"lat\":18.5158057,\"lng\":73.9271644},\"radius\":4000},\"type\":\"circle\"}}",
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7cb5aac3-848b-40f5-bf4c-ae1a2b3b777c",
  • "account_id": 5,
  • "id": 32139,
  • "name": "LocationViaAPI",
  • "data": {
    },
  • "created_date": 1652898263,
  • "updated_date": 1653546812,
  • "is_start_point": 0
}

Asset

Create Asset

Create an asset at account level.

header Parameters
apiKey
required
string

Key to authenticate

Request Body schema: application/json

Asset can be created with the following fields.

name
required
string

Name of the asset

description
string

Asset description

client_asset_number
required
string

Unique id of the asset as given by the client. It should be unique across all the assets of the client account.

alert_threshold
object

Sensor reading thresholds can be set at the asset level. An alert is generated if the sensor readings go beyond the set range.

device_imei
string

The imei (or a unique id) of the tracking device is mapped to the asset.

parent_bee
string

Active device name which has to be attached with the asset.

custom_fields
object

Custom fields are part of the asset creation template. Custom field is a key value pair where value is an array of strings.

categories
object

Custom classification preconfigured at the account level.

subscriptions
Array of objects

User email ids and phone numbers

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Mask Factory-v2",
  • "client_asset_number": "AAA999"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "total": 1,
  • "data": [
    ]
}

Get List of Asset (V1)

It provides the capability to search and sort through all available assets in an account. Searching is based on a query string parameter called selector.

header Parameters
apiKey
required
string

Key to authenticate

Request Body schema: application/json

Selector is a powerful parameter similar to the SQL where clause. In filters, you can apply various combinations to fetch your assets.

required
object

Give all conditions similar to SQL.

Responses

Request samples

Content type
application/json
Example
{
  • "selector": {
    }
}

Response samples

Content type
application/json
{
  • "id": 47994,
  • "uuid": "6883f279-face-4a09-ad17-75e0cf1e18d8",
  • "client_asset_number": "AAA475",
  • "description": "Editted description",
  • "active_status": 0,
  • "device_imei": "999921042408074565",
  • "name": "my asset",
  • "created_date": 1629711178,
  • "updated_date": 1629712616,
  • "zone_id": null,
  • "alert_threshold": {
    },
  • "parent_bee": null,
  • "external_feed": null,
  • "subscriptions": [
    ],
  • "custom_fields": {
    },
  • "categories": {
    },
  • "geo": { }
}

Get Asset Details

Returns the details of a particuar asset.

path Parameters
uuid
required
string

Unique identifier for the asset

header Parameters
apiKey
required
string

Key to authenticate

Responses

Response samples

Content type
application/json
{
  • "id": 47994,
  • "uuid": "6883f279-face-4a09-ad17-75e0cf1e18d8",
  • "client_asset_number": "AAA475",
  • "description": "Editted description",
  • "active_status": 0,
  • "device_imei": "999921042408074565",
  • "name": "my asset",
  • "created_date": 1629711178,
  • "updated_date": 1629712616,
  • "zone_id": null,
  • "alert_threshold": {
    },
  • "parent_bee": null,
  • "external_feed": null,
  • "subscriptions": [
    ],
  • "custom_fields": {
    },
  • "categories": {
    },
  • "geo": { }
}

Edit Asset Details

Edit the details of a particuar asset.

path Parameters
uuid
required
string

Unique identifier for the asset

header Parameters
apiKey
required
string

Key to authenticate

Request Body schema: application/json

Update the details of an asset based on its uuid. Give only those attributes with editted values.

name
string

Name of the asset

description
string

Asset description

client_asset_number
string

Unique id of the asset as given by the client. It should be unique across all assets of the client's account.

alert_threshold
object

Sensor reading thresholds can be set at the asset level. If the sensor readings go beyond the set range, an alert is generated.

device_imei
string

The imei (or unique id) of the tracking device is mapped to the asset.

custom_fields
object

Custom fields are part of the asset creation template. Custom field is a key value pair where value is an array of strings.

categories
object

Custom classification is preconfigured at the account level.

subscriptions
Array of objects

User email ids and phone numbers

Responses

Request samples

Content type
application/json
Example
{
  • "description": "Editted description"
}

Response samples

Content type
application/json
{
  • "id": 47994,
  • "updated_date": 1630571259
}

Delete Asset

Delete an asset based on its uuid.

path Parameters
uuid
required
string

Unique identifier for the asset

header Parameters
apiKey
required
string

Key to authenticate

Responses

Response samples

Content type
application/json
{ }

Get List of Asset (V2)

It provides the capability to search and sort through all available assets in an account. On passing the condition under the filter, it will return all asset details based on the filter condition. This is a light weight API. Different supported operators are

  1. eq → Exact match with field
  2. ne → Exact match with field for not equals
  3. has → Regexp match with field
  4. gt → Greater than
  5. gte → Greater than or equal to
  6. lt → Less than
  7. lte → Less than or equal to
  8. and → AND matching between two or more fields
  9. or → OR matching between two or more fields

query Parameters
$filter
string
Examples:
  • $filter=name has 'Box' and created_date lte 1693993320000 -
  • $filter=bee_name eq 'TestBee-99998888888871' and created_date gte 1618906857 -
  • $filter=bee_name eq 'TestBee-99998888888871' or client_asset_number has 'Box-1' -

Search condition. Few fields that you can filter on are

  1. client_asset_number (Inventory Number)
  2. name (Inventory Name)
  3. bee_name (Bee Name)
  4. created_date (Created Date)

Refer examples for more details. Other than these fields, you can also use the fields that are in the response of the API.

$size
number
Examples:
  • $size=5 -

This specifies result count. If not specified by default it will return 10 records. Maximum value can be 100. For more please use pagination.

$offset
number

Offset from start of records. Calculated as (desired_page_num - 1) * size

$fields
string
Examples:
  • $fields=all -

Fetch the fields

header Parameters
apiKey
required
string

Key to authenticate

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "size": 10,
  • "total": 56,
  • "data": [
    ]
}

Webhook

Get List of Webhook Alerts Summary

Retrieves a list of webhook alerts filtered by specified conditions. This endpoint allows various filters to tailor the returned data to specific needs.

query Parameters
type
string
Example: type=DEVICE

Type of alerts to filter by (e.g., ACTIVITY, DEVICE, ASSET).

entity_id
string
Example: entity_id=123e4567-e89b-12d3-a456-426614174000

Specific identifier for shipment/asset UUID or device IMEI to filter webhook data.

startDate
integer
Example: startDate=1609459200

Start date for filtering webhook data, provided as a Unix timestamp. use with endDate

endDate
integer
Example: endDate=1612137600

End date for filtering webhook data, provided as a Unix timestamp. use with startDate

webhook_category
string
Example: webhook_category=webhook_sent

Filter to retrieve specific categories of webhook alerts like webhook_total, webhook_sent, or webhook_resent.

header Parameters
apiKey
required
string
Example: your_api_key_here

API key for authentication.

Responses

Response samples

Content type
application/json
{}

Retrieve Communication Audit Data

This endpoint retrieves communication audit data. By default, not all fields are included. Use specific query parameters to include all fields, paginate responses, order the data, or apply filters based on various attributes.

query Parameters
$fields
string
Example: $fields=all

to include all fields in the response.

$size
integer
Example: $size=10

Number of records per request for pagination.

$offset
integer
Example: $offset=20

Number of records to skip for pagination.

$orderBy
string
Example: $orderBy=created_date

Order the records by any field. To order in descending, append desc (e.g., created_date desc).

$filter
string
Example: $filter=is_success eq true

Apply filters on fields such as attempts, created_date, is_success, entity_id, event, alert_type, url. Filters can be combined using 'and'. Examples:

  • $filter=attempts eq 1: Filters records where attempts equal 1.
  • $filter=created_date gte 1715020200 and created_date lte 1718735399: Filters records within the specified date range.
  • $filter=is_success eq true and alert_type eq 'DEVICE': Filters records where the alert type is 'DEVICE' and the operation was successful.
header Parameters
apiKey
required
string
Example: your_api_key_here

API key for authentication.

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "size": 0,
  • "total": 0,
  • "data": [
    ]
}