Skip to main content

Returns account usage insights

GET 

/account-usages/:accountId/summaries

This API returns a summary of account usage insights for past 12 months.

Request

Path Parameters

    accountId stringrequired

    ID of IDN account

    Example: ef38f94347e94562b5bb8424a56397d8

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Default value: 0

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: date

    Example: -date

Responses

Summary of account usage insights for past 12 months.

Schema

  • Array [

  • date date

    The first day of the month for which activity is aggregated.

    count int64

    The number of days within the month that the account was active in a source.

  • ]

Loading...