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.

Fielding:

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

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

curl

curl -i 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

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "6fee87b1-5f86-470c-80ca-9c3922653de9",
      "type": "exports",
      "attributes": {
        "status": "Processing",
        "created_at": "2021-12-13T20:02:07.798Z",
        "url": null,
        "callback_url": null,
        "callback_method": null,
        "export_type": "cdr_in"
      }
    },
    {
      "id": "33bdfff7-4de3-4c58-8c90-b99930fb984a",
      "type": "exports",
      "attributes": {
        "status": "Processing",
        "created_at": "2021-12-16T06:39:44.465Z",
        "url": null,
        "callback_url": null,
        "callback_method": null,
        "export_type": "cdr_in"
      }
    },
    {
      "id": "d4f37476-8ece-4add-bbcb-cc72a7908fe2",
      "type": "exports",
      "attributes": {
        "status": "Processing",
        "created_at": "2021-12-16T06:54:30.122Z",
        "url": null,
        "callback_url": "http://10.201.10.1/test.php",
        "callback_method": "GET",
        "export_type": "cdr_in"
      }
    },
    {
      "id": "88a29a27-11fe-4db0-a508-eca1d7cf0b68",
      "type": "exports",
      "attributes": {
        "status": "Completed",
        "created_at": "2021-12-21T07:37:13.085Z",
        "url": "https://api.didww.com/v3/exports/a8bf7c0e-0c08-44ca-b0e2-db34a1d2006a.csv.gz",
        "callback_url": null,
        "callback_method": null,
        "export_type": "cdr_out"
      }
    },
    {
      "id": "67e4f27f-d5eb-4b80-8924-39486aee6ed4",
      "type": "exports",
      "attributes": {
        "status": "Completed",
        "created_at": "2021-12-21T07:42:02.546Z",
        "url": "https://api.didww.com/v3/exports/b15d6a4b-3c99-4bee-af6b-f5f37ce30511.csv.gz",
        "callback_url": "http://10.201.10.1/test.php",
        "callback_method": "GET",
        "export_type": "cdr_out"
      }
    },
    {
      "id": "77165c85-0a37-43d1-b3f8-c76d2eb50315",
      "type": "exports",
      "attributes": {
        "status": "Completed",
        "created_at": "2021-12-21T07:54:35.789Z",
        "url": "https://api.didww.com/v3/exports/94593896-818a-4a00-b89b-e4d825f4c0d5.csv.gz",
        "callback_url": "http://10.201.10.1/test.php",
        "callback_method": "GET",
        "export_type": "cdr_out"
      }
    }
  ],
  "meta": {
    "total_records": 6,
    "api_version": "2021-12-15"
  },
  "links": {
    "first": "https://api.didww.com/v3/exports?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "https://api.didww.com/v3/exports?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}

Other Responses

Code

Success

Description

401

No

Unauthorized