Get Exports#

Description

Returns a collection of Exports.

Forming Request#

Request Method: GET

Request Path: /v3/exports

URI Parameters:

Name

Type

Is Required?

Description

sort

string

Optional

Sorting

Sorting:

Value

Sorts by:

status

The status field.

created_at

The created_at field.

Sparse Fieldsets:

Value

Returns:

filters

The filters attribute.

status

The status attribute.

created_at

The created_at attribute.

url

The url attribute.

callback_url

The callback_url attribute.

callback_method

The callback_method attribute.

Example#

http

1GET /v3/exports HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]

curl

1curl -i -X GET https://api.didww.com/v3/exports -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

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": "2021-12-13T20:02:07.798Z",
12        "url": null,
13        "callback_url": null,
14        "callback_method": null,
15        "export_type": "cdr_in"
16      }
17    },
18    {
19      "id": "33bdfff7-4de3-4c58-8c90-b99930fb984a",
20      "type": "exports",
21      "attributes": {
22        "status": "Processing",
23        "created_at": "2021-12-16T06:39:44.465Z",
24        "url": null,
25        "callback_url": null,
26        "callback_method": null,
27        "export_type": "cdr_in"
28      }
29    },
30    {
31      "id": "d4f37476-8ece-4add-bbcb-cc72a7908fe2",
32      "type": "exports",
33      "attributes": {
34        "status": "Processing",
35        "created_at": "2021-12-16T06:54:30.122Z",
36        "url": null,
37        "callback_url": "http://example.com",
38        "callback_method": "GET",
39        "export_type": "cdr_in"
40      }
41    },
42    {
43      "id": "88a29a27-11fe-4db0-a508-eca1d7cf0b68",
44      "type": "exports",
45      "attributes": {
46        "status": "Completed",
47        "created_at": "2021-12-21T07:37:13.085Z",
48        "url": "https://api.didww.com/v3/exports/a8bf7c0e-0c08-44ca-b0e2-db34a1d2006a.csv.gz",
49        "callback_url": null,
50        "callback_method": null,
51        "export_type": "cdr_out"
52      }
53    },
54    {
55      "id": "67e4f27f-d5eb-4b80-8924-39486aee6ed4",
56      "type": "exports",
57      "attributes": {
58        "status": "Completed",
59        "created_at": "2021-12-21T07:42:02.546Z",
60        "url": "https://api.didww.com/v3/exports/b15d6a4b-3c99-4bee-af6b-f5f37ce30511.csv.gz",
61        "callback_url": "http://example.com",
62        "callback_method": "GET",
63        "export_type": "cdr_out"
64      }
65    },
66    {
67      "id": "77165c85-0a37-43d1-b3f8-c76d2eb50315",
68      "type": "exports",
69      "attributes": {
70        "status": "Completed",
71        "created_at": "2021-12-21T07:54:35.789Z",
72        "url": "https://api.didww.com/v3/exports/94593896-818a-4a00-b89b-e4d825f4c0d5.csv.gz",
73        "callback_url": "http://example.com",
74        "callback_method": "GET",
75        "export_type": "cdr_out"
76      }
77    }
78  ],
79  "meta": {
80    "total_records": 6,
81    "api_version": "2021-12-15"
82  },
83  "links": {
84    "first": "https://api.didww.com/v3/exports?page%5Bnumber%5D=1&page%5Bsize%5D=50",
85    "last": "https://api.didww.com/v3/exports?page%5Bnumber%5D=1&page%5Bsize%5D=50"
86  }
87}

Other Responses#

Code

Success

Description

401

No

Unauthorized