Event Monitoring API

Learn more about monitoring events using the Event Monitoring API.

Use the Event Monitoring to determine how many events the Reltio Data Pipeline transferred to your Snowflake environment within a specific interval of time. Event Monitoring supports queries for any period up to one day within the past 30 days. Each response includes event IDs and timestamps that you can use to trace individual events across your Reltio tenant, cloud storage, and Snowflake environment, so you can identify exactly where in the transfer process an event succeeded, stalled, or failed to load into Snowflake.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the event monitoring request:

GET {hub-url}/api/tenants/{tenantId}/monitoring/_eventMonitoring

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`hub-url`	String	Yes	The data pipeline hub URL for your tenant environment. Example: `environment-data-pipeline-hub.reltio.com`.
`tenantId`	String	Yes	The unique identifier of the tenant. Specifies the tenant context for the request. Example: `ce5627DYnQ6abcD`.

Query parameters

The following table describes the supported query parameters.


Parameter	Type	Required	Description	Accepted values / Default
`from`	Number	No	Start of the monitoring interval in milliseconds (UNIX Epoch). Use to define the earliest point in the time range for which the API returns event transfer data.	Any valid epoch timestamp. Default: 1 day before current time.
`to`	Number	No	End of the monitoring interval in milliseconds (UNIX Epoch). Use to define the latest point in the time range for which the API returns event transfer data.	Any valid epoch timestamp. Default: Current time.
`detailed`	Boolean	No	When set to `Yes`, returns detailed information for each event transferred within the specified time frame. The detailed response includes individual event records sourced from CRUD Events and Match Events only. If the specified time frame contains only `ACTIVITY_CREATED_UPDATED` events, individual event records are not returned. The response includes only `total_events_count` and `total_incomplete_events_count`.	`Yes` or `No`. Default: `No`.
`max`	Number	No	Maximum number of incomplete events returned in the response.	Any positive integer. Default: `10`.

Request headers

The following request headers must be included.


Header	Value	Required
`Authorization`	`Bearer <access_token>`	Yes
`Content-Type`	`application/json`	Yes

Example request

The following example shows a complete request that retrieves detailed event information for a specific time range.

GET https://environment-data-pipeline-hub.reltio.com/api/tenants/ce5627DYnQ6abcD/monitoring/_eventMonitoring?from=1778800000000&to=1778813200000&detailed=Yes

Response body

The response returns the events transferred for a tenant ID. The structure of the response varies based on the detailed parameter and the event types present in the specified time frame.

The following table describes the fields returned in the response body.


Field	Type	Description
`total_events_count`	Number	Total number of events transferred within the specified time interval.
`total_incomplete_events_count`	Number	Total number of incomplete events within the specified time interval.
`events`	Array	List of individual event objects. Returned only when `detailed=Yes` and the time frame contains CRUD Events or Match Events. Not returned when only `ACTIVITY_CREATED_UPDATED` events are present.
`events[].eventId`	String	Unique identifier for the event.
`events[].eventType`	String	Type of the event. Example: `ENTITY_CHANGED`.
`events[].eventState`	String	Processing state of the event. Example: `DATAPIPELINE_PROCESSED`.
`events[].objectUri`	String	URI of the entity or object associated with the event.
`events[].timestamp`	Number	Time the event was recorded, in epoch milliseconds.
`events[].checksum`	Number	Combined checksum of the event. Use this value to verify data integrity across systems.
`events[].platform_checksum`	Number	Checksum value assigned by the Reltio platform.
`events[].data_pipeline_checksum`	Number	Checksum value assigned by the data pipeline.

Example responses

The following examples show the two response structures returned when detailed=Yes, depending on the event types present in the specified time frame.

Response when CRUD Events or Match Events are present

When detailed=Yes and the time frame contains CRUD Events or Match Events, the response includes an events array with individual event records.

{
  "total_events_count": 4,
  "total_incomplete_events_count": 0,
  "events": [
    {
      "eventId": "EVENT_1",
      "eventType": "ENTITY_CHANGED",
      "eventState": "DATAPIPELINE_PROCESSED",
      "objectUri": "OBJECT_URI",
      "timestamp": 1778804661713,
      "checksum": 1979971583,
      "platform_checksum": 260095,
      "data_pipeline_checksum": 1979711488
    },
    {
      "eventId": "EVENT_2",
      "eventType": "ENTITY_CHANGED",
      "eventState": "DATAPIPELINE_PROCESSED",
      "objectUri": "OBJECT_URI",
      "timestamp": 1778813105733,
      "checksum": 1979971583,
      "platform_checksum": 260095,
      "data_pipeline_checksum": 1979711488
    }
  ]
}

Response when only ACTIVITY_CREATED_UPDATED events are present

When detailed=Yes and the time frame contains only ACTIVITY_CREATED_UPDATED events, the events array is not included. The response returns only the event counts.

{
  "total_events_count": 4,
  "total_incomplete_events_count": 0
}

To validate complete event details, query the entities table in your Snowflake worksheet using the objectUri from the API response to locate the corresponding record and confirm the event was loaded correctly.

The following example shows a Snowflake worksheet query and its results for a matching entity record.

Unify and manage your data