---
title: "Consumption Monitoring"
description: "Signer consumption monitoring APIs, with information and reports on user operations, and how to create the API key with the Monitor role."
canonical: "https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/consumption-monitoring"
locale: "en"
product: "Signer"
last_updated: "2026-10-12"
---

# Consumption Monitoring

## Introduction
To support monitoring, Signer has a set of APIs that expose information and reports about the operations users
perform.

To call these APIs you need a **monitoring API key**.

## Creating a monitoring API key

To create one, create an application, selecting the `Sys Admin` organization and the `Monitor` role:

![Applications](https://docs.lacunasoftware.com/images/signer/applications.png)

![Create application Monitor](https://docs.lacunasoftware.com/images/signer/create-application-monitor.png)

> **Warning**
>
> The `Monitor` role only grants access to the APIs that are relevant to monitoring.

Then create the key with the "Keys" button:

![Application keys](https://docs.lacunasoftware.com/images/signer/application-keys.png)

![Application create Administration key](https://docs.lacunasoftware.com/images/signer/application-keys-add.png)

![Create key submit](https://docs.lacunasoftware.com/images/signer/create-key.png)

## Monitoring options

Choose one of the use cases below:

* [Generate a document report](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/consumption-monitoring#generate-a-document-report)

* [Get document totals](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/consumption-monitoring#get-document-totals)

### Generate a document report

To get an Excel report of all documents created in a period, call `POST /api/reports/documents/date`:

```json
POST /api/reports/documents/date
{
    "startDateUtc": "2023-01-01",
    "endDateUtc": "2023-01-31"
}
```

* startDateUtc - `string`: date and time (optional) when the period starts.

* endDateUtc - `string`: date and time (optional) when the period ends.

The response carries a download path for the generated report (append the returned value to the site's base URL):

```json
{
    "location": "/api/reports/f7044565-7cd4-4628-bb17-76eedbf9fe31?access_ticket=..."
}
```

### Get document totals

To get the number of documents and envelopes created in a period, call `POST /api/documents/date`:

```json
POST /api/documents/date
{
    "startDateUtc": "2023-01-01",
    "endDateUtc": "2023-01-31"
}
```

* startDateUtc - `string`: date and time (optional) when the period starts.

* endDateUtc - `string`: date and time (optional) when the period ends.

The response carries the totals of documents and envelopes created:

```json
{
    "totalDocuments": 0,
    "totalEnvelopes": 0
}
```