Usage Stats API
This API allows you to pull data about your organization's account usage from Q-Fi. This article provides the details on how to authenticate, access the available endpoints, request/response formats, and example usage.
End Point: https://<account-domain-here>.qfimr.com
Example: https://abcdcompany.qfimr.com
- Access your API key by clicking on your profile icon in the top right of the screen.
- Then click on API
Note: You are allowed to regenerate the key, regeneration will invalidate the previously generated key.
In the popup, copy your API key or click regenerate to create a new key and invalidate the previously generated key.
Endpoints
xxxxxxxxxx1
1
GET /projects/SurveySummaryDescription
Retrieve detailed information about your account usage.
Request Headers
| Header | Type | Description |
| api-key | String | YOUR_API_KEY |
| domain | String | YOUR_SUBDOMAIN_NAME |
Query Parameters
| Parameter | Type | Description |
| StartDate | String | Start date in YYYY-MM-DD format |
| EndDate | String | End date in YYYY-MM-DD format |
| SurveyId | Number | Optional (Survey Id) |
| Status | String | Completed, Quotafull, Terminated (Optional) |
Example Request
xxxxxxxxxx7
1
curl –location 'https:// YOUR_SUBDOMAIN_NAME.qfimr.com /projects/SurveySummary?SurveyId=1754 \2
--header 'api-key: YOUR_API_KEY ' \3
--header 'domain: YOUR_SUBDOMAIN_NAME \4
5
curl –location 'https:// YOUR_SUBDOMAIN_NAME.qfimr.com /projects/SurveySummary?SurveyId=1754&StartDate=2023-01-01&EndDate=2024-01-01&Status=completed' \6
--header 'api-key: YOUR_API_KEY ' \7
--header 'domain: YOUR_SUBDOMAIN_NAME \Example Response:
xxxxxxxxxx10
1
{2
Completed: 0,3
Screened: 0,4
Terminated: 0,5
QuotaFull: 0,6
Qualified:0,7
AvgCompletionTime:02:02:00,8
CompletionRate:2.5,9
MedianCompeltionTime:02:02:0210
}