Sign in

v1

latestOpenAPI 3.0.0The MIT License (MIT)2026-07-14614962.2 KB

Create an asynchronous report

Request a report on your account activity

post/v2/reports

Request body

OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "account_id": "abcdef01",
  "callback_url": "https://requestb.in/12345",
  "date_end": "2018-01-01T00:00:00+00:00",
  "date_start": "2017-12-01T00:00:00+00:00",
  "product": "SMS",
  "direction": "outbound",
  "from": "441234567890",
  "network": "23415",
  "status": "delivered",
  "to": "441234567890"
}

Response

OK

OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "_links": {
    "self": {
      "href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
    }
  },
  "account_id": "abcdef01",
  "callback_url": "https://requestb.in/12345",
  "date_end": "2018-01-01T00:00:00+00:00",
  "date_start": "2017-12-01T00:00:00+00:00",
  "product": "SMS",
  "receive_time": "2019-06-28T15:30:00+0000",
  "request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "request_status": "PENDING",
  "start_time": "2019-06-28T15:30:00+0000",
  "direction": "outbound",
  "from": "441234567890",
  "network": "23415",
  "status": "delivered",
  "to": "441234567890"
}