SDK Usage
SDK Usage
GET
https://app.contentstack.com/analytics/v2/sdk?from={YYYY-MM-DD}&to={YYYY-MM-DD}&orgUid={organization_uid}&includeCount={boolean_value}&services={["cdn","cma"]}&duration={duration}The SDK Usage request gets you the number of requests that were made using the SDKs. It helps you get an overview of the SDK usage by your customers.
Here’s how your response body would look like when you pass the jobId in the Retrieve Data endpoint.
{
"total": 16,
"totalDocs": 4,
"data": [
{
"count": 7,
"type": "cdn",
"sdk": "cda-collection/v9.31.0",
"date": "2024-02-09"
},
{
"count": 4,
"type": "cdn",
"sdk": "cda-collection/v9.31.0",
"date": "2024-02-12"
},
{
"count": 3,
"type": "cdn",
"sdk": "cda-collection/v9.31.0",
"date": "2024-02-08"
},
{
"count": 2,
"type": "cdn",
"sdk": "cda-collection/v9.31.0",
"date": "2024-02-15"
},
{
"date": "2024-02-28"
}
],
"meta": {
"orderBy": -1,
"from": "2024-01-31",
"to": "2024-02-28",
"orgUid": "blt**************87",
"includeCount": true,
"services": "[\"cdn\",\"cma\"]",
"duration": "day"
},
"uid": "0f****46-5ee9-4f38-9146-1f********8"
}
The response body provides detailed insights into how SDKs are being used across different services. Here’s a breakdown of the key elements:
- count: The number of requests executed using a specific SDK on a given date.
- type: The service type, such as "cdn".
- sdk: The SDK version used for the requests.
- date: The date when the SDK requests were executed.
This response helps organizations track SDK adoption and effectiveness by revealing usage patterns and frequency.
Sample Response
Status|200 OK
{
"jobId": "job_7******a-c**f-4**9-9**0-c**********6",
"paginated": true
}