Learn

Analytics API

The MATTR VII Analytics service allows collecting, storing and viewing analytics data from other services in the form of events. This events database can be seen as a history of all the requests made by a tenant to the platform. The events can be generated with different ranges of data, ranging from no data up to a full response being recorded.

The Analytics service uses a standard publisher-subscriber architecture. MATTR VII services create and publish events that are pushed to a queue. The Analytics service then consumes these events and stores them in a database.

The Analytics API enables you to query the database for events and retrieve their metadata and data.

Query Parameters

You can query the database using the following parameters (All parameters support comma separated lists):

  • ids: Query by event IDs. These can be retrieved from event details.

    Example: ids=e4c387e7-3e63-40f4-9a38-062aaae9ee50.

  • requestIds: Query by request IDs. These can be retrieved from event details. The response will include all the individual events that are part of the queried request.

    Example: requestIds=e4c387e7-3e63-40f4-9a38-062aaae9ee50.

  • categories: Query by event categories. Every category includes several event types. When both the categories and types parameters are provided, the request applies an OR logic so the response will return all events that match either. Refer to Category and Type Options for an inclusive list of available categories.

    Example: categories=dcc.

  • types: Query by event types. Each event type is part of a category. When both the categories and types parameters are provided, the request applies an OR logic so the response will return all events that match either. Refer to Category and Type Options for an inclusive list of available types.

    Example: categories=DCC_SIGN_START.

  • dateFrom / dateTo: Query by event start and/or end date and time, in ISO-8601 format.

    Examples:

    dateFrom=2023-06-01T02:45:44.087Z

    dateTo=2023-06-30T23:59:59.999Z

Use the limit and cursor parameters in your request to control the response pagination, as detailed in our API Reference.

All query parameters are optional. If no parameters are provided, the most recent 100 events are returned by default.

What’s Next?

You can now refer to Query for Events to learn how to use our Analytics API to query for tenant events.