Usage#
Retrieves detailed workflow usages with different frequencies. This includes past usage for workflows that have been deleted. If a workflow is not found, the reported usage will default to 0.
Hourly#
The POST /processing/{workflow_id}}/usage/hourly endpoint is available to check the number of processed credits, documents, pages or the average time per page on an hourly basis.
See also the auto-generated API documentation.
Parameters#
| Field | Type | Description |
|---|---|---|
{workflow_id} |
string | The workflow identifier to request usages for. |
{start} |
string | Start of the requested range as partial ISO-8601 datetime. Input format is {datetime_format}. Additional precision is discarded.Serves as an inclusive lower bound for the returned data points. |
{end}(optional) |
string | End of the requested range as partial ISO-8601 datetime. Input format is {datetime_format}. Additional precision is discarded.Serves as an inclusive upper bound for the returned data points. The span from start to end must be at most a day. Defaults to start + 6 hours. |
{extended}(optional) |
boolean | If this flag is set to true, additional indicators (num_documents, num_pages, average_time_per_page) will be aggregated for each window. (Default value: False) |
Daily#
The POST /processing/{workflow_id}}/usage/daily endpoint is available to check the number of processed credits, documents, pages or the average time per page on a daily basis.
See also the auto-generated API documentation.
Parameters#
| Field | Type | Description |
|---|---|---|
{workflow_id} |
string | The workflow-key to request usages for. |
{start} |
string | Start of the requested range as partial ISO-8601 datetime. Input format is {datetime_format}. Additional precision is discarded.Serves as an inclusive lower bound for the returned data points. |
{end}(optional) |
string | End of the requested range as partial ISO-8601 datetime. Input format is {datetime_format}. Additional precision is discarded.Serves as an inclusive upper bound for the returned data points. The span from start to end must be at most a month. Defaults to start + 7 days. |
{extended}(optional) |
boolean | If this flag is set to true, additional indicators (num_documents, num_pages, average_time_per_page) will be aggregated for each window. (Default value: False) |
Weekly#
The POST /processing/{workflow_id}}/usage/weekly endpoint is available to check the number of processed credits, documents, pages or the average time per page on an weekly basis.
See also the auto-generated API documentation.
Parameters#
| Field | Type | Description |
|---|---|---|
{workflow_id} |
string | The workflow-key to request usages for. |
{start} |
string | Start of the requested range as partial ISO-8601 datetime. Input format is {datetime_format}. Additional precision is discarded.Serves as an inclusive lower bound for the returned data points. |
{end}(optional) |
string | End of the requested range as partial ISO-8601 datetime. Input format is {datetime_format}. Additional precision is discarded.Serves as an inclusive upper bound for the returned data points. The span from start to end must be at most 5 months. Defaults to start + 28 days. |
{extended}(optional) |
boolean | If this flag is set to true, additional indicators (num_documents, num_pages, average_time_per_page) will be aggregated for each window. (Default value: False) |
Monthly#
The POST /processing/{workflow_id}}/usage/monthly endpoint is available to check the number of processed credits, documents, pages or the average time per page on an monthly basis.
See also the auto-generated API documentation.
Parameters#
| Field | Type | Description |
|---|---|---|
{workflow_id} |
string | The workflow-key to request usages for. |
{start} |
string | Start of the requested range as partial ISO-8601 datetime. Input format is {datetime_format}. Additional precision is discarded.Serves as an inclusive lower bound for the returned data points. |
{end}(optional) |
string | End of the requested range as partial ISO-8601 datetime. Input format is {datetime_format}. Additional precision is discarded.Serves as an inclusive upper bound for the returned data points. The span from start to end must be at most a year. Defaults to start. |
{extended}(optional) |
boolean | If this flag is set to true, additional indicators (num_documents, num_pages, average_time_per_page) will be aggregated for each window. (Default value: False) |
Response format#
Always#
date: The time of the processing. The frequency of the reported times depends on the route used.processed_credits: The number of credits used.
Extended#
num_documents: Total number of documents.num_pages: Sum of pages in all documents.average_time_per_page: The average processing time per page.