v1

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

List reports

List reports created by the specified account based on filtered provided.

get/v2/reports

Query parameters

account_idstring required

The account for which the list of reports will be queried.

statusstring required

A comma-separated list of report status values. Reports with any of the statuses specified are returned. The values in the comma-seperated list specified for status can be any of PENDING, PROCESSING, SUCCESS, ABORTED, FAILED, TRUNCATED.

date_fromstring date

ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date from which the list of reports will be queried. Format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z.

date_tostring date

ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date until which the list of reports will be queried. Format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z.

Response

OK

items_countinteger

The number of reports in the list.

self_linkstring uri

URI of this search.

Example response

{
  "reports": [
    {
      "_links": {
        "download_report": {
          "href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
        },
        "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": "SUCCESS",
      "start_time": "2019-06-28T15:30:00+0000",
      "direction": "outbound",
      "from": "441234567890",
      "network": "23415",
      "status": "delivered",
      "to": "441234567890"
    }
  ],
  "self_link": "https://api.nexmo.com/v2/reports/"
}
All 6 operations