Get Exports#
Returns a collection of Exports.
Request#
HTTP Method: GET
URI Path: /v3/exports
Note
For all returned data attributes, see Export Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
filter[<filter_name>] |
|
No |
|
fields[exports] |
|
No |
|
sort |
|
No |
|
page[number] |
|
No |
|
page[size] |
|
No |
Page size. Pagination defaults to |
Filters#
The collection includes Exports of every type, including Exports created with earlier API
versions. A filter on export_type also matches those earlier Exports of the same type.
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
|---|---|---|---|---|
id |
|
No |
Yes |
The Export ID. |
external_reference_id |
|
No |
No |
The |
export_type |
|
No |
Yes |
The |
status |
|
No |
Yes |
The |
created_at_gteq |
|
No |
No |
Exports created on or after the specified date and time. |
created_at_lteq |
|
No |
No |
Exports created on or before the specified date and time. |
Filters that allow an array accept a comma-separated list of values, for example
filter[export_type]=sms_in,sms_out. An Export matches when it matches any listed value.
Sorting#
Value |
Description |
|---|---|
status |
The |
created_at |
The |
external_reference_id |
The |
Examples#
http
1GET /v3/exports?filter%5Bexport_type%5D=cdr_in HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
curl
1curl -i -X GET 'https://api.didww.com/v3/exports?filter%5Bexport_type%5D=cdr_in' -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": [
6 {
7 "id": "6fee87b1-5f86-470c-80ca-9c3922653de9",
8 "type": "exports",
9 "attributes": {
10 "status": "processing",
11 "created_at": "2026-10-13T20:02:07.798Z",
12 "external_reference_id": null,
13 "url": null,
14 "callback_url": null,
15 "callback_method": null,
16 "export_type": "cdr_in",
17 "filters": {
18 "from": "2026-09-01 00:00:00",
19 "to": "2026-09-30 23:59:59",
20 "did_number": "123456789"
21 }
22 }
23 },
24 {
25 "id": "33bdfff7-4de3-4c58-8c90-b99930fb984a",
26 "type": "exports",
27 "attributes": {
28 "status": "processing",
29 "created_at": "2026-10-16T06:39:44.465Z",
30 "external_reference_id": null,
31 "url": null,
32 "callback_url": null,
33 "callback_method": null,
34 "export_type": "cdr_in",
35 "filters": {
36 "from": "2026-09-01 00:00:00",
37 "to": "2026-09-30 23:59:59",
38 "did_number": "123456789"
39 }
40 }
41 },
42 {
43 "id": "d4f37476-8ece-4add-bbcb-cc72a7908fe2",
44 "type": "exports",
45 "attributes": {
46 "status": "processing",
47 "created_at": "2026-10-16T06:54:30.122Z",
48 "external_reference_id": null,
49 "url": null,
50 "callback_url": "http://example.com",
51 "callback_method": "get",
52 "export_type": "cdr_in",
53 "filters": {
54 "from": "2026-09-01 00:00:00",
55 "to": "2026-09-30 23:59:59",
56 "did_number": "123456789"
57 }
58 }
59 }
60 ],
61 "meta": {
62 "total_records": 3,
63 "api_version": "2026-11-19"
64 },
65 "links": {
66 "first": "https://api.didww.com/v3/exports?filter%5Bexport_type%5D=cdr_in&page%5Bnumber%5D=1&page%5Bsize%5D=50",
67 "last": "https://api.didww.com/v3/exports?filter%5Bexport_type%5D=cdr_in&page%5Bnumber%5D=1&page%5Bsize%5D=50"
68 }
69}
http
1GET /v3/exports?filter%5Bexport_type%5D=cdr_out HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
curl
1curl -i -X GET 'https://api.didww.com/v3/exports?filter%5Bexport_type%5D=cdr_out' -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": [
6 {
7 "id": "88a29a27-11fe-4db0-a508-eca1d7cf0b68",
8 "type": "exports",
9 "attributes": {
10 "status": "completed",
11 "created_at": "2026-10-21T07:37:13.085Z",
12 "external_reference_id": null,
13 "url": "https://api.didww.com/v3/exports/a8bf7c0e-0c08-44ca-b0e2-db34a1d2006a.csv.gz",
14 "callback_url": null,
15 "callback_method": null,
16 "export_type": "cdr_out",
17 "filters": {
18 "from": "2026-09-01 00:00:00",
19 "to": "2026-09-30 23:59:59",
20 "voice_out_trunk.id": "457bf47d-446d-41cd-91c3-dfbda7bf0753"
21 }
22 }
23 },
24 {
25 "id": "67e4f27f-d5eb-4b80-8924-39486aee6ed4",
26 "type": "exports",
27 "attributes": {
28 "status": "completed",
29 "created_at": "2026-10-21T07:42:02.546Z",
30 "external_reference_id": null,
31 "url": "https://api.didww.com/v3/exports/b15d6a4b-3c99-4bee-af6b-f5f37ce30511.csv.gz",
32 "callback_url": "http://example.com",
33 "callback_method": "get",
34 "export_type": "cdr_out",
35 "filters": {
36 "from": "2026-09-01 00:00:00",
37 "to": "2026-09-30 23:59:59",
38 "voice_out_trunk.id": "457bf47d-446d-41cd-91c3-dfbda7bf0753"
39 }
40 }
41 },
42 {
43 "id": "77165c85-0a37-43d1-b3f8-c76d2eb50315",
44 "type": "exports",
45 "attributes": {
46 "status": "completed",
47 "created_at": "2026-10-21T07:54:35.789Z",
48 "external_reference_id": null,
49 "url": "https://api.didww.com/v3/exports/94593896-818a-4a00-b89b-e4d825f4c0d5.csv.gz",
50 "callback_url": "http://example.com",
51 "callback_method": "get",
52 "export_type": "cdr_out",
53 "filters": {
54 "from": "2026-09-01 00:00:00",
55 "to": "2026-09-30 23:59:59",
56 "voice_out_trunk.id": "457bf47d-446d-41cd-91c3-dfbda7bf0753"
57 }
58 }
59 }
60 ],
61 "meta": {
62 "total_records": 3,
63 "api_version": "2026-11-19"
64 },
65 "links": {
66 "first": "https://api.didww.com/v3/exports?filter%5Bexport_type%5D=cdr_out&page%5Bnumber%5D=1&page%5Bsize%5D=50",
67 "last": "https://api.didww.com/v3/exports?filter%5Bexport_type%5D=cdr_out&page%5Bnumber%5D=1&page%5Bsize%5D=50"
68 }
69}
http
1GET /v3/exports?filter%5Bexport_type%5D=sms_in%2Csms_out&filter%5Bstatus%5D=completed&filter%5Bcreated_at_gteq%5D=2026-10-01 HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
curl
1curl -i -X GET 'https://api.didww.com/v3/exports?filter%5Bexport_type%5D=sms_in%2Csms_out&filter%5Bstatus%5D=completed&filter%5Bcreated_at_gteq%5D=2026-10-01' -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": [
6 {
7 "id": "b1e0c6b4-2f7d-4a59-9b0e-6a3c51f7d2e8",
8 "type": "exports",
9 "attributes": {
10 "status": "completed",
11 "created_at": "2026-10-21T08:15:27.341Z",
12 "external_reference_id": "sms-in-2026-09",
13 "url": "https://api.didww.com/v3/exports/3d8e5f0a-61b7-4c2e-9f14-7a0b2c9d5e63.csv.gz",
14 "callback_url": null,
15 "callback_method": null,
16 "export_type": "sms_in",
17 "filters": {
18 "from": "2026-09-01 00:00:00",
19 "to": "2026-09-30 23:59:59",
20 "destination_address_eq": "441234567890",
21 "status": "success",
22 "trunk_type": ["http_in", "smpp_esme"]
23 }
24 }
25 },
26 {
27 "id": "5c9a3e1d-7b42-4f86-a0d3-9e2b8c6f1a47",
28 "type": "exports",
29 "attributes": {
30 "status": "completed",
31 "created_at": "2026-10-21T08:21:03.907Z",
32 "external_reference_id": null,
33 "url": "https://api.didww.com/v3/exports/e7a2c4b9-0d63-4f1e-8b5a-2c9f6d3e1b70.csv.gz",
34 "callback_url": "https://example.com/didww/exports",
35 "callback_method": "post",
36 "export_type": "sms_out",
37 "filters": {
38 "from": "2026-10-01 00:00:00",
39 "to": "2026-10-20 23:59:59",
40 "service_type": "a2p",
41 "sms_trunk.id": "0f8f2b76-3c1e-4d2a-8b55-1e9a7c4d6f30"
42 }
43 }
44 }
45 ],
46 "meta": {
47 "total_records": 2,
48 "api_version": "2026-11-19"
49 },
50 "links": {
51 "first": "https://api.didww.com/v3/exports?filter%5Bcreated_at_gteq%5D=2026-10-01&filter%5Bexport_type%5D=sms_in%2Csms_out&filter%5Bstatus%5D=completed&page%5Bnumber%5D=1&page%5Bsize%5D=50",
52 "last": "https://api.didww.com/v3/exports?filter%5Bcreated_at_gteq%5D=2026-10-01&filter%5Bexport_type%5D=sms_in%2Csms_out&filter%5Bstatus%5D=completed&page%5Bnumber%5D=1&page%5Bsize%5D=50"
53 }
54}
Other Responses#
Code |
Success |
Description |
|---|---|---|
400 |
No |
|
401 |
No |
|
429 |
No |
The request budget of the account for the current window is spent ( |