Usage Analytics
GET https://{{base_url}}/analytics/v2/usage?orgUid={{orgUid}}&includeCount=true&from=2024-01-31&duration=day&to=2024-03-31&services=["cdn","cma"]
The Usage Analytics request gives a quick usage overview of your bandwidth and API utilization over a particular period of time.
To use the API request, you will need to authenticate yourself either with an Authtoken.Â
Read more about it in Authentication.
For more information, refer to the Usage Analytics API Reference document
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
orgUid | string | Enter the UID of your Organization. | |
includeCount | boolean | Set this parameter to true to include the total count of users in the response. | |
from | string | Specify the start date for the required data. Use the following date format: YYYY-MM-DD. | |
duration | string | Enter a value like day, week, or month. This parameter determines the granularity of the data you want to fetch. | |
to | string | Enter the current date or any date after the from date. The date format should be: YYYY-MM-DD. | |
services | string | Specify the array of services for which you want statistics, such as: ["cma", "ui", "cdn", "graphql", "images", "assets", "automations", "launch"]. | |
orderBy | number | Enter 1 to sort the SDK response in ascending order, or -1 to sort it in descending order. | |
limit | number | Specify the number of items you wish to fetch per request. The maximum limit is 900. | |
skip | number | Enter the number of items to skip. For example, a skip value of 10 will skip the first 10 items. | |
apiKey | string | Enter the API key of the stack. | |
projectUid | string | Enter the Launch project UID to retrieve data from that specific project. | |
environmentUid | string | Enter the environment UID of the Launch project. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
authtoken | string | Enter your authtoken . | |
Content-Type | string |