Request

Response

    Client Usage Daily Totals
    GET

    clients/{id}/usage/daily-totals

    Returns the daily usage for an application that you own or have collaborator access to.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/applications/v1/clients/{id}/usage/daily-totals
    Authentication Context
    User context required
    Required OAuth Scopes
    application:client:read
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow or a Secure Service Account (SSA) flow.

    The SSA flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context.

    * Required

    Request

    URI Parameters

    id
    string
    The client ID of the application.

    Request

    Query String Parameters

    filter[date]
    string
    A date range to query. If not specified, the last 30 days will be returned.

    The query should be formatted as <YYYY-MM-DD>..<YYYY-MM-DD>. The range cannot exceed 200 days.

    filter[service]
    string
    A service name to filter the results by.

    Response

    HTTP Status Code Summary

    200
    OK
    Successfully retrieved the daily usage for the application.
    400
    Bad Request
    Provided date range is invalid or exceeds the maximum allowed range.
    401
    Unauthorized
    The request did not have a valid access token. Obtain a fresh access token and try again.
    403
    Forbidden
    You do not have permission to perform the operation specified by the request.
    404
    Not Found
    Specified application does not exist.

    Response

    Body Structure (200)

    Expand all
    results
    array: object
    An array of objects where each object contains the date and its usage records.
    date
    string
    The date of the usage record. Days begin at 00:00 UTC.
    usage
    array: object
    An array of objects where each object contains the service and the number of tokens consumed.
    service
    enum:string
    The name of the service that was used. Possible values: DATA_MANAGEMENT, DESIGN_AUTOMATION, DESIGN_AUTOMATION_V3_REVIT, DESIGN_AUTOMATION_V3_3DMAX, DESIGN_AUTOMATION_V3_AUTOCAD, DESIGN_AUTOMATION_V3_INVENTOR, FLOW_GRAPH_ENGINE, MODEL_DERIVATIVE_SIMPLE, MODEL_DERIVATIVE_COMPLEX, REALITY_CAPTURE, ACC_ISSUES, BIM_360_ISSUES, DATA_MANAGEMENT_FOLDERS
    tokens
    number
    The number of tokens consumed on this date. This amount can be in fractions.
    unchargedTokens
    number
    The number of uncharged tokens on this date. This amount can be in fractions.
    quantity
    number
    The number of units of value on this date.
    unit
    string
    The unit of the quantity.
    unchargedQuantity
    number
    The number of uncharged `unit`s on this date.

    Example

    Successfully retrieved the daily usage for the application.

    Request

    curl -v 'https://developer.api.autodesk.com/applications/v1/clients/:id/usage/daily-totals?filter[date]=2020-01-01..2020-01-31&filter[service]=REALITY_CAPTURE' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
    

    Response

    {
      "results": [
        {
          "date": "2063-04-05",
          "usage": [
            {
              "service": "REALITY_CAPTURE",
              "tokens": 47.5,
              "unchargedTokens": 47.6,
              "quantity": 48,
              "unit": "photos",
              "unchargedQuantity": 246
            }
          ]
        }
      ]
    }
    
    Show More