Request

Response

    API Basics

    The Data API is separated into two categories:

    • Usage Query: API to get usage and consumption data associated with seat usage for Single User Subscriptions and token consumption for Flex.
    ../../../_images/usage-queries-overview-diagram.png
    • Export Usage: API to export subscription information, user management lists, and daily seat usage and token consumption data by team.
    ../../../_images/exports-overview-diagram.png

    This diagram outlines workflow when using the API. When acquiring a 3-Legged OAuth access token, the associated user must be an Administrators of teams with Business Success Plan benefits. Reports return JSON in response to Usage Query endpoint. To download CSV/EXCEL/JSON reports, use the Export Usage endpoint (see the walkthrough).

    Getting Started

    Use the Reference Guide to obtain information about interacting with the different API endpoints.