Data Models
TimeSeriesViewModel
One row of data in a /analytics response.
| Property | Type | Description |
|---|---|---|
| event | string | Name of the event |
| system | string | The Doc Gen application that recorded the event |
| date | string | Day of the events, UTC, as YYYY-MM-DD |
| hour | string | Hour of the day, UTC, 00 to 23 |
| template | string | Template the event relates to |
| source | string | Where the event came from |
| distribution | string | How the result was distributed |
| environment | string | The environment name sent by the application that recorded the event |
| area | string | Functional area of the event |
| count | integer | Number of events in that hour for this combination |
| eventDetail | string | Extra context for the event. Can be null |
The application that records an event decides the text in event, system, template, source, distribution, environment, area and eventDetail. Fields that were not recorded come back as null.
Values you will see
The Doc Gen applications record events with these names. Other sources can send other names, so treat the lists as the usual values, not a closed set.
| Field | Values |
|---|---|
| event | Create, Update, Sign, Archive, Error, Delete, Restore, Export, Import, View, Print, Send, Share, Complete, Search |
| system | Smartforms, Editor, Centerpoint, Workflow, PagesManager, Pages, Archive |
| environment | Development, Test, PreProd, Production |
eventDetail narrows the event down. SmartForms, for example, records Create with form-created, Complete with form-completed, Sign with form-signed, Archive with form-archived, and Error with validation-error. It sets template to the name of the form and environment to the environment the form ran in.
PagedResponse
| Property | Type | Description |
|---|---|---|
| pageNumber | integer | Current page number |
| pageSize | integer | Rows per page |
| totalRecords | integer | Number of rows in the whole range |
| totalPages | integer | totalRecords divided by pageSize, rounded up |
| data | array | The rows of this page |
Prometheus mapping
/analytics/prometheus uses the same fields, with these changes:
| Field | In the Prometheus output |
|---|---|
| event | Becomes the metric name, <event in lower case>_event_count |
| count | Becomes the metric value |
| date, hour | Not present, the counts are totals for the range |
| all other fields | Labels, named in lower case |