Skip to main content

Create a Telco Data usage report

POST 

/reporting/telco_data_usage_reports

Check the status and retrieve a Telco Data Usage Report with a call to: GET /reporting/telco_data_usage_reports/{id}

  • Telco Data Usage Reports are available for 30 days

Request

Body

required

Parameters required to request a Telco Data usage report

    start_date daterequired

    Start date in UTC, must be at most 31 days ago

    end_date daterequired

    End date in UTC

    aggregation_type stringrequired

    ALL

Responses

200: Successful response

Schema

    data

    id string

    ID of the generated report

    start_date string

    2024-02-13

    end_date string

    2024-02-14

    aggregation_type string

    ALL

    status string

    PENDING, COMPLETE, FAILED, EXPIRED

    report_url string

    Link to the generated report

    result

    object[]

  • Array [

  • user_id string

    ID of the user who owns the data in this record

    aggregations

    object[]

  • Array [

  • type string

    LRN, CNAM, or Switch Data

    total_dips integer

    Total number of dips for the given Telco Data type and reporting period

    total_cost number

    Total cost for the given Telco Data type and reporting period

    currency string

    USD

  • ]

  • ]

  • created_at string

    Date and time (UTC) when the report was generated

    updated_at string

    Date and time (UTC) when the report was last updated, or null if it has not been updated yet

400: Bad request

Schema

    errors

    object[]

  • Array [

  • code string

    Error code, expressed as a stringified integer

    title string

    Short summary of the problem

    detail string

    Explanation specific to this occurrence of the problem

  • ]

401: Unauthorized

Schema

    errors

    object[]

  • Array [

  • code string

    Error code, expressed as a stringified integer

    title string

    Short summary of the problem

    detail string

    Explanation specific to this occurrence of the problem

  • ]

404: Resource not found

Schema

    errors

    object[]

  • Array [

  • code string

    Error code, expressed as a stringified integer

    title string

    Short summary of the problem

    detail string

    Explanation specific to this occurrence of the problem

  • ]

422: Invalid parameters supplied in request

Schema

    errors

    object[]

  • Array [

  • code string

    Error code, expressed as a stringified integer

    title string

    Short summary of the problem

    detail string

    Explanation specific to this occurrence of the problem

  • ]

Loading...