CDR Export Status

Query the status of a CDR Export Request.

Endpoint

GET /cdrs/exports/:cdrexport_id

Path Parameters

  • id
    integer required

    The id of the CDR Request made previously. See Query CDRs.

Response Fields

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

  • data
    object

    CDR Export request object composed of the following:

    • 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
    string

    Links object stored request searched for. For example, https://api.flowroute.com/v2/cdrs/exports/38647.

Example Request

GET /v2/cdrs/exports/38647 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/38647 -u accessKey:secretKey

Example Responses

200 OK


{'data':
	'type': 'cdrexport',
	'id': '38647',
	'attributes': {
		'callback_url': 'http://myserver.com/webhook',
		'status': 'completed',
		'download_url': ('https://s3.us-east-2.amazonaws.com/uiuc-presigned-url-example/secret.'
			'txt?X-Amz-Date=20170720T182534Z&X-Amz-SignedHeaders;=host&X-Amz-Creden;'
			'tial=ASIAIYLQNVRRFNZOCFBA%2F20170720%2Fus-east-2%2Fs3%2Faws4_request&'
			'X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires;=604800&X-Amz-Security-;'
			'Token=FQoDYXdzEJP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDOLWx95j90zPxGh7WSL'
			'dAVnoYoKC4gjrrR1xbokFWRRwutmuAmOxaIVcQqOy%2Fqxy%2FXQt3Iz%2FohuEEmI7%2'
			'FHPzShy%2BfgQtvfUeDaojrAx5q8fG9P1KuIfcedfkiU%2BCxpM2foyCGlXzoZuNlcF8o'
			'hm%2BaM3wh4%2BxQ%2FpShLl18cKiKEiw0QF1UQGj%2FsiEqzoM81vOSUVWL9SpTTkVq8'
			'EQHY1chYKBkBWt7eIQcxjTI2dQeYOohlrbnZ5Y1%2F1cxPgrbk6PkNFO3whAoliSjyRC8'
			'e4TSjIY2j3V6d9fUy4%2Fp6nLZIf9wuERL7xW9PjE6eZbKOHnw8sF&X-Amz-Signature;'
			'=a14b3065ab822105e8d7892eb5dcc455ddd603c61e47520774a7289178af9ecc'),
		 'requested_at': '2018-09-11T23:21:20+00:00'
		 'created_at': '2018-09-11T23:23:23+00:00'
		 'expires_at': '2018-09-14T23:23:29+00:00',
		 'total_cost': '34.321300',
		 'usf_fees': '5.93190',
		 'ccrf': '0.0',
		 'num_calls': 301,
		 'billed_minutes': 10,
		 'filter_parameters': {
			"start_call_start_time": "2019-01-01 00:00:00",
			"start_call_end_time": "2019-02-01 00:00:00",
			"number_aliases": "['Office 221', 'Office 888']"
		 }
	},
	'links': {
		'self': 'http://cdr-api/cdrs/exports/38647'
    }
}

404 NOT FOUND

{
  "errors": [
    {
      "detail": "CDR Export Record not associated with your account or expired: 38647. ",
      "id": "6c91c6a9-e0aa-4369-9f39-d68b83556a3e",
      "status": 404,
      "title": "Resource not found."
    }
  ]
}