List CDR Export Requests

Returns a list of all submitted CDR Requests on your Flowroute account.

Endpoint

GET /cdrs/exports

Query Parameters

  • status
    string

    Display only requests whose status matches the specified value. Possible values are processing, completed or failed.

  • limit
    integer

    Limits the number of items to retrieve. A maximum of 200 items can be retrieved with 10 being the default value if not specified.

  • offset
    integer

    Offsets the list of requests by your specified value. For example, if you have 4 requests and you entered 1 as your offset value, then only 3 of your requests will be displayed in the response.

Response Fields

On success, the HTTP status code in the response header is 200 OK and the response body contains an array of CDR Export objects in JSON format. On error, the header status code is an error code and the response body contains an array of error objects.

  • data
    array

    An array of CDR Export objects in your account that satisfy your query.

    • attributes
      object

      Different attributes of the CDR Export Request:

      • id
        integer

        ID of the CDR resource in the system.

      • type
        string

        This will always be cdrexport.

      • attributes
        object

        Object detailing the attributes defined in the CDR Request..

        • callback_url
          string

          The notification location if specified.

        • status
          string

          The processing status of the request.

        • download_url
          string

          Once complete, the location of the generated data file.

        • requested_at
          datetime

          Timestamp of the request (UTC).

        • created_at
          datetime

          Processing initation timestamp (UTC).

        • expires_at
          datetime

          When the download URL will no longer be available (UTC).

        • total_cost
          float

          Total cost in dollars of all records in the report including all fees and cnamlookup costs.

        • call_subtotal
          float

          A summation of the call cost less any fees within the export.

        • connect_fees
          float

          A summation of fees collected for inbound Toll Free calls within the export.

        • cnamlookup_fees
          float

          A summation of fees for CNAM lookups on inbound calls within the export.

        • usf_fees
          float

          A summation of all Universal Service Fund fees collected on calls within the export.

        • ccrf
          float

          A summation of the Carrier Cost Recovery fees incurred for the calls within the export

        • num_calls
          integer

          The total number of calls in the export.

        • billed_minutes
          integer

          The total number of minutes (integer) that were billed for this query.

        • filter_parameters
          object
          • start_call_start_time
            datetime

            .

          • start_call_end_time
            datetime

            .

          • number_aliases
            array

            .

          • Only the parameters specified in the query are returned here. For a full list of the available parameters, see Query CDRs.
  • links
    object

    Links object pointing to your search and a link to the next page if any. For example, https://api.flowroute.com/v2/cdrexports?starts_with=1206&limit=10&offset=0.

Example Request

GET /v2/cdrs/exports?status=completed HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Example Request

curl -X GET https://api.flowroute.com/v2/cdrs/exports?status=completed -u accessKey:secretKey

Example Responses

200 OK


{
  "data": [
    {
      "data": {
        "attributes": {
          "billed_minutes": 0,
          "callback_url": null,
          "ccrf": "0.0",
          "created_at": "2019-03-18T23:20:30+00:00",
          "download_url": "https://s3.us-west-2.amazonaws.com/flowroute-cdrexports/40375/2019/3/18/e55f474c3154a14cd2cec842f79ca6a8000.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential;=ASIA2DG5LFSOIDMMFUVW%2F20190318%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date;=20190318T232030Z&X-Amz-Expires;=259200&X-Amz-SignedHeaders;=host&X-Amz-Security-Token;=FQoGZXIvYXdzEJz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDBB4u7fdwDGKfgWUSyKZBF6fKcf16poJprJr9imLeVtLmQCcWKWnJjmmkRLz%2FQKjaMUvHTnTo4drHg8KWAbvvbpwoC3NOgFsn28nw1fHlgBjVODuIDeMJxFHROUZAPTbayDsUttyO%2BqbcluTENh3ESJoZGoXi3sGwHDvvtcYTtHr0MQMw7cvEEKgKvaMp7KgliTpwJzzquAPeMQg2LD5C%2FR36nI%2BZNXrqp64ZovMrtVV1IR9KLXTkRZs3%2Ft%2Bvt7CzhM8Fopc96cKhu%2FpX7eVR%2BBJfTeUD%2FPvz19KWuKWsM9V%2FEqNptPTADIg6LtupuainAJVhvBaatHOdGe7aUt2ABkvsCZVs5uFbdy79aHVMMtZgN886E1TsVR%2FDwbg1AhfsxLBujEumIn9bJAkr1RJpHakrC67gm%2FyTsU64huC%2BGCqQrd5CHIAQsbDCV8tMPw5K%2B3SonWV2TLusiOg%2FWZikSMqgDrexj7KQo7utXWGAAt2W4INKGSpwY1BoOWJGl6rBMJ1rWpERJ2lxagHeAPd8tOPiKVvkytscHH1vEgM4S1wOApspud5tMsvtkhyAWGwfsbkn1ZiF5PoqUbBjHXH9m%2Bq8p4oLUEI2aozdrLEqdQxELSlleQna0U1VsxyRa%2BXRjxDU7oOpmqETzUEx3NKELDGOb%2FwzO%2F8HH%2BqPcC8OVaox2KdLvAFwHGulKLwRrtSlblZopzZqrBmd0R5X60tZ4u2KIUH3lLeiSiGvb%2FkBQ%3D%3D&X-Amz-Signature;=beb0e34bbd48cac63ce1db887de6f783238acddcfd7675b3a525ae49003d2cb7",
          "expires_at": "2019-03-21T23:20:30+00:00",
          "filter_parameters": {
            "number_aliases": [
              "Home Phone"
            ],
            "start_call_end_time": "2019-01-01T00:00:00+00:00",
            "start_call_start_time": "2018-12-01T00:00:00+00:00"
          },
          "num_calls": 0,
          "requested_at": "2019-03-18T23:20:17+00:00",
          "status": "completed",
          "total_cost": "0.0",
          "call_subtotal": "0.0",
          "connect_fees": "0.0",
          "cnamlookup_fees": "0.0",
          "usf_fees": "0.0"
        },
        "id": 203485,
        "type": "cdrexport"
      }
    },
    {
      "data": {
        "attributes": {
          "billed_minutes": 0,
          "callback_url": null,
          "ccrf": "0.0",
          "created_at": "2019-03-18T23:16:47+00:00",
          "download_url": "https://s3.us-west-2.amazonaws.com/flowroute-cdrexports/40375/2019/3/18/8294b10fd18846d61ab1de8535f05b55000.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential;=ASIA2DG5LFSOIDMMFUVW%2F20190318%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date;=20190318T231647Z&X-Amz-Expires;=259200&X-Amz-SignedHeaders;=host&X-Amz-Security-Token;=FQoGZXIvYXdzEJz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDBB4u7fdwDGKfgWUSyKZBF6fKcf16poJprJr9imLeVtLmQCcWKWnJjmmkRLz%2FQKjaMUvHTnTo4drHg8KWAbvvbpwoC3NOgFsn28nw1fHlgBjVODuIDeMJxFHROUZAPTbayDsUttyO%2BqbcluTENh3ESJoZGoXi3sGwHDvvtcYTtHr0MQMw7cvEEKgKvaMp7KgliTpwJzzquAPeMQg2LD5C%2FR36nI%2BZNXrqp64ZovMrtVV1IR9KLXTkRZs3%2Ft%2Bvt7CzhM8Fopc96cKhu%2FpX7eVR%2BBJfTeUD%2FPvz19KWuKWsM9V%2FEqNptPTADIg6LtupuainAJVhvBaatHOdGe7aUt2ABkvsCZVs5uFbdy79aHVMMtZgN886E1TsVR%2FDwbg1AhfsxLBujEumIn9bJAkr1RJpHakrC67gm%2FyTsU64huC%2BGCqQrd5CHIAQsbDCV8tMPw5K%2B3SonWV2TLusiOg%2FWZikSMqgDrexj7KQo7utXWGAAt2W4INKGSpwY1BoOWJGl6rBMJ1rWpERJ2lxagHeAPd8tOPiKVvkytscHH1vEgM4S1wOApspud5tMsvtkhyAWGwfsbkn1ZiF5PoqUbBjHXH9m%2Bq8p4oLUEI2aozdrLEqdQxELSlleQna0U1VsxyRa%2BXRjxDU7oOpmqETzUEx3NKELDGOb%2FwzO%2F8HH%2BqPcC8OVaox2KdLvAFwHGulKLwRrtSlblZopzZqrBmd0R5X60tZ4u2KIUH3lLeiSiGvb%2FkBQ%3D%3D&X-Amz-Signature;=8b4dab6a349ecc98905d949d026889035101ee8acb34055efb87ca2c299e4ba4",
          "expires_at": "2019-03-21T23:16:47+00:00",
          "filter_parameters": {
            "number_aliases": [
              "Home Phone"
            ],
            "start_call_end_time": "2018-10-01T00:00:00+00:00",
            "start_call_start_time": "2018-10-01T00:00:00+00:00"
          },
          "num_calls": 0,
          "requested_at": "2019-03-18T23:16:46+00:00",
          "status": "completed",
          "total_cost": "0.0",
          "call_subtotal": "0.0",
          "connect_fees": "0.0",
          "cnamlookup_fees": "0.0",
          "usf_fees": "0.0"
        },
        "id": 203484,
        "type": "cdrexport"
      }
    }
  ],
  "links": {
    "next": "http://cdr-api/cdrs/exports?offset=2&limit;=2",
    "self": "http://cdr-api/cdrs/exports?offset=0&limit;=2"
  }
}

422 UNPROCESSABLE ENTITY

{
  "errors": [
    {
      "detail": {
        "limit": [
          "Not a valid integer."
        ]
      },
      "id": "07f2df99-f31d-45ce-93d3-1512f81ab27d",
      "status": 422
    }
  ]
}