curl --location 'https://api.sbmg.app/v1/reporting/usage' \
--header 'x-api-key: YOUR_API_KEY'
{
"data": [
{
"account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
"destination_address": "6422999888",
"direction": "OUTBOUND",
"content": "Hello world",
"date": "2023-06-14T09:06:46Z",
"user_metadata": {
"key2": "value 3"
}
},
{
"account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
"destination_address": "6421765432",
"direction": "OUTBOUND",
"content": "Good morning...",
"date": "2023-06-14T09:07:12Z",
},
{
"account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
"source_address": "6422999888",
"direction": "INBOUND",
"content": "Boom! Hello!",
"date": "2023-06-14T09:10:56Z",
"user_metadata": {
"key2": "value 3"
}
},
]
}
Reports
Account Usage Report
GET
/
v1
/
reporting
/
usage
curl --location 'https://api.sbmg.app/v1/reporting/usage' \
--header 'x-api-key: YOUR_API_KEY'
{
"data": [
{
"account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
"destination_address": "6422999888",
"direction": "OUTBOUND",
"content": "Hello world",
"date": "2023-06-14T09:06:46Z",
"user_metadata": {
"key2": "value 3"
}
},
{
"account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
"destination_address": "6421765432",
"direction": "OUTBOUND",
"content": "Good morning...",
"date": "2023-06-14T09:07:12Z",
},
{
"account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
"source_address": "6422999888",
"direction": "INBOUND",
"content": "Boom! Hello!",
"date": "2023-06-14T09:10:56Z",
"user_metadata": {
"key2": "value 3"
}
},
]
}
Body
curl --location 'https://api.sbmg.app/v1/reporting/usage' \
--header 'x-api-key: YOUR_API_KEY'
Response
An array of message log entries containing the following fields
Show Toggle object
Show Toggle object
The account ID associated with the message.
The phone number of the message recipient.
The direction of the message (e.g. “OUTBOUND”).
The content of the message.
The timestamp of the message in ISO 8601 format.
Additional metadata associated with the message.
{
"data": [
{
"account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
"destination_address": "6422999888",
"direction": "OUTBOUND",
"content": "Hello world",
"date": "2023-06-14T09:06:46Z",
"user_metadata": {
"key2": "value 3"
}
},
{
"account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
"destination_address": "6421765432",
"direction": "OUTBOUND",
"content": "Good morning...",
"date": "2023-06-14T09:07:12Z",
},
{
"account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
"source_address": "6422999888",
"direction": "INBOUND",
"content": "Boom! Hello!",
"date": "2023-06-14T09:10:56Z",
"user_metadata": {
"key2": "value 3"
}
},
]
}
⌘I