Skip to main content
GET
https://api.sbmg.app
/
report
curl --location 'https://api.sbmg.app/report?start_date=2023-06-12&end_date=2023-06-14&metadata_key=myMetdataKey' \
--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": {
        "myMetdataKey": "value 3"
      }
    },
    {
      "account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
      "source_address": "6422999888",
      "direction": "INBOUND",
      "content": "Boom! Hello!",
      "date": "2023-06-14T09:10:56Z",
      "user_metadata": {
        "myMetdataKey": "value 1"
      }
    },
  ]
}

​
Query

​
start_date
string
required
Start date of the report query. Format YYYY-MM-DD for example: 2023-01-30
​
end_date
string
required
End date of the report query. Format YYYY-MM-DD for example: 2023-01-30
​
metadata_key
string
Filter for messages containing a given metadata key.
curl --location 'https://api.sbmg.app/report?start_date=2023-06-12&end_date=2023-06-14&metadata_key=myMetdataKey' \
--header 'x-api-key: YOUR_API_KEY'

​
Response

​
data
array
An array of message log entries containing the following fields
{
  "data": [
    {
      "account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
      "destination_address": "6422999888",
      "direction": "OUTBOUND",
      "content": "Hello world",
      "date": "2023-06-14T09:06:46Z",
      "user_metadata": {
        "myMetdataKey": "value 3"
      }
    },
    {
      "account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
      "source_address": "6422999888",
      "direction": "INBOUND",
      "content": "Boom! Hello!",
      "date": "2023-06-14T09:10:56Z",
      "user_metadata": {
        "myMetdataKey": "value 1"
      }
    },
  ]
}