/consumptions/metrics
GET {{base-api-url}}/consumptions/metrics
You are able to easily monitor your consumption of the different services offered by Yousign:
- simpleSignature: the number of finished electronic signatures (please note that 1 procedure completed with 2 signatories will be counted as 2)
- advancedSignature: the number of finished Advanced Electronic Signatures
- archiving: the volume of archived documents (in bytes) through the Yousign API
- serverStamp: the number of documents sealed using a server stamp
- documentVerification: the number of identity or bank documents verified by API. Identity verifications performed in the context of Advanced Electronic Signature are not included in this counter.
The consumption is calculated for the entire workspace.
Filters
You can filter the results for a more precise analysis of your consumption:
- by specifying the period for which you want to know your consumption => period[<after|before|strictly_after|strictly_before>]=value or period=value
- if you both use the API and the application, you can use the source filter => source=api|app
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | This value is a secret and needs to be replaced by your API Key (Bearer). | |
Content-Type | string | This header specifies the format of the exchanges in JSON. |
RESPONSES
status: OK
{"simpleSignature":957,"advancedSignature":238,"serverStamp":57,"documentVerification":12,"archiving":66356}