Monitoring API (1.22.0)

The RELEX Monitoring API provides a way to access monitoring data for RELEX services. The API allows customers to retrieve information about events that have occurred in their environments, such as file processing events and job execution events.

• File and job execution events related to RELEX supply chain planning services.
• (Upcoming) Prometheus-compatible metrics endpoint for data ingestion golden signals.

RELEX customers can use the Monitoring API to:

• Monitor the progress of file processing events. Since the set of uploaded files is known, RELEX users can poll the Monitoring API to check the status of each file. If a file seems to be stuck in processing or has failed validation, the user can take action to correct the issue.
• Monitor the progress of job execution events. RELEX users can poll the Monitoring API to check the status of important jobs, such as supply chain planning calculation runs. A job failing to complete by a certain time can indicate a problem with the data or the RELEX service.
• (Upcoming) Query data ingestion metrics to monitor throughput and latency of data flowing into RELEX. Customers can use these metrics to build dashboards and alerts in their own observability platforms via Prometheus-compatible scraping or federation.

File events and statuses

See the Get File Events endpoint for example file event payload.

File events are grouped by the file name originally used when uploading the file to RELEX. The file events endpoint returns a list of file names along with the current status of the data contained in each file. The status of a file can be one of the following:

Status	Description
Received	The file has been received by RELEX, but no further processing has yet happened.
Processing	The data contained in the file is being validated and transferred via intermediate storage to RELEX supply chain planning.
Processed	The data is fully validated and ready to be used in supply chain planning calculations.
Exported	A customer-facing file has been created by RELEX, but it has not yet been delivered to customer-facing storage.
Delivering	A customer-facing file is currently being delivered to customer-facing storage.
Delivered	A customer-facing file has been delivered to customer-facing storage.
Warning	A non-critical issue was encountered during processing of the file. Usually caused by some rows being skipped during file validation.
Error	A critical error occurred during processing of the file.

Along with the status, the file events endpoint returns a list of events that have occurred.

Event	Description
File received	The file has been received in an upload location by RELEX.
File preparation started	The file is being read in and validated by the data integration application known as RELEX Connect.
File preparation completed	The file has been fully validated by RELEX Connect and the data is now uploaded to intermediate storage for use in supply chain planning.
File import started	The data is now being read from intermediate storage to RELEX Plan, the core RELEX supply chain planning application.
File import completed	The data has been fully read and is ready for use in supply chain planning calculations.
File is ready for processing	The data is ready for pricing and promotion strategy optimization.
Export file created	A customer-facing export file has been created by RELEX.
Export file ready for preparation	The export file is being prepared for delivery to customer-facing storage.
Export file uploaded to customer-facing storage	The export file has been uploaded to customer-facing storage and is available for download.

Integration direction

The API provides information about the direction of data integration. Two types of integration are supported: inbound and outbound.

• Inbound integration is used to upload data to RELEX.
• Outbound integration is used to download data from RELEX.

The integration direction is indicated in the file event payload via the direction field. It can also be specified as an optional direction query parameter in the file event endpoint. Additionally:

• For inbound integrations, the file event payload includes the input_url field, which defines the full path of the file on the file server.
• For outbound integrations, the corresponding field is output_url.

Possible values for the 'direction' field are:

Direction	Description	File path field name
inbound	Data is being uploaded to RELEX.	input_url
outbound	Data is being downloaded from RELEX.	output_url

File rows

⚠️ Functionality is available from Plan 10.6 and higher.

Events with 'File preparation started', 'File preparation completed', and 'File import completed' statuses also include information about the number of total and skipped rows in the file. This information is provided in 'file_rows' object. The 'file_rows' object contains the following fields:

Field	Description
total	Total number of data rows present in the uploaded file.
skipped	Number of rows skipped while processing the uploaded file

For some events, the API provides information on the reasons for skipping rows, in which case the event will also include a 'warnings' object.
The overall status of the file will be 'Warning' if any rows were skipped during processing, unless there were also critical errors.

Example:

{
  "file": "transactions_20251204_110001.csv",
  "input_url": "https://example-storage.blob.core.windows.net/input",
  "status": "Warning",
  "direction": "inbound",
  "file_size": 694713,
  "timestamp": "2025-12-04T14:12:10Z",
  "events": [
    {
      "title": "File received",
      "timestamp": "2025-12-04T11:36:01Z"
    },
    {
      "title": "File preparation started",
      "timestamp": "2025-12-04T14:11:48Z",
      "file_rows": {
        "total": 5973,
        "skipped": 1339
      },
      "warnings": [
        {
          "details": "Null value in non-null column relex_transaction_type",
          "count": 1326,
          "example_rows": [
            "2025-12-03,LOC01,LOC02,,-6.0,CS,-6.0,CS,REF001,Invoice,TYPE1,CAT1,ORD001,ID001,SO",
            "2025-12-03,LOC01,LOC02,,-1.0,CS,-1.0,CS,REF002,Invoice,TYPE1,CAT1,ORD002,ID002,SO",
            "2025-12-03,LOC01,LOC02,,-35.0,CS,-35.0,CS,REF003,Invoice,TYPE1,CAT1,ORD003,ID003,SO",
            "2025-12-03,LOC01,LOC02,,-8.0,CS,-8.0,CS,REF004,Invoice,TYPE1,CAT1,ORD004,ID004,SO",
            "2025-12-03,LOC01,LOC02,,-36.0,CS,-36.0,CS,REF005,Invoice,TYPE1,CAT1,ORD005,ID005,SO"
          ]
        },
        {
          "details": "Null value in non-null column primary_qty",
          "count": 13,
          "example_rows": [
            "2025-12-03,LOC03,SKU01,DELIVERY,,LB,40.0,CS,REF006,IR Description,TYPE2,CAT2,ORD006,ID006,OT",
            "2025-12-03,LOC03,SKU02,DELIVERY,,LB,60.0,CS,REF007,IR Description,TYPE2,CAT2,ORD007,ID007,OT",
            "2025-12-03,LOC03,SKU03,DELIVERY,,LB,60.0,CS,REF008,IR Description,TYPE2,CAT2,ORD008,ID008,OT",
            "2025-12-03,LOC03,SKU04,DELIVERY,,LB,55.0,CS,REF009,IR Description,TYPE2,CAT2,ORD009,ID009,OT",
            "2025-12-03,LOC01,SKU05,DELIVERY,,LB,192.0,CS,REF010,IR Description,TYPE2,CAT2,ORD010,ID010,OP"
          ]
        }
      ]
    },
    {
      "title": "File preparation completed",
      "timestamp": "2025-12-04T14:12:10Z",
      "file_rows": {
        "total": 4634,
        "skipped": 0
      }
    }
  ]
},

The following table lists the most common warning messages:

Warning Details	Reason
Missing required non-null fields, fields=”comma-separated list of fields”	The input file specification contains fields marked as 'Not null', but the provided file is missing these fields.
Could not parse value of type "type-name"	The input file specification defines a field of a specific type, but the provided file contains a value that does not match the specified type.
Number of columns on row does not match the header or linebreaks are inconsistent	The number of fields in the provided file does not match the input file specification, or inconsistent linebreaking characters are used in the data.

File size

⚠️ Functionality is available for SFTP file uploads

Shows the size of the file in bytes. The file size is included in the file_size field of the file event object.

Errors

If a critical error occurs during file processing, the endpoint will return a list of errors and the overall status of the file is "Error". Each error consists of a title that describes at what stage the error occurred and a details field that provides more information about the error.

Example:

{
  "file": "Locations_2025-01-23.csv",
  "status": "Error",
  "timestamp": "2025-01-23T07:38:22Z",
  "file_size": 15,
  "events": [
    {
      "title": "File preparation started",
      "timestamp": "2025-01-23T07:38:16Z"
    }
  ],
  "errors": [
    {
      "title": "File preparation started",
      "details": "The file you are looking for may have been moved or deleted"
    }
  ]

Job events

See the Get Job Events endpoint for example job event payload.

The RELEX Monitoring API provides access to events linked to RELEX Plan job executions. By querying the job events endpoint, RELEX users can find out about the current state of scheduled jobs in RELEX Plan and whether or not they have completed successfully.

Jobs can have the following statuses:

Status	Description
Running	The job is in progress.
Canceled	The job was canceled when the Cancel button was selected. The job is also marked as Canceled if the continue criteria set in WaitFor is not met and WaitFor is set to not continue the execution of the job.
Completed	The job has completed successfully.
Error	The job has failed or has been aborted by the system (for example, due to a system restart).
Queued	The job is lined up and waiting to be processed. There are more jobs started than can be executed simultaneously. You can configure the number, and the default is 5 jobs. The job remains in the Queued status until earlier jobs have completed.
Warning	The job has completed, but some of the child runs executed within the job have failed with an error.
Pending	The job is awaiting initiation.
Delayed	The job start has been postponed.

Jobs can be filtered by a number of fields, including:

• job name (job_name) - the request will return jobs whose names contain the specified string
• job parent name (job_parent_name) - will return jobs whose parent job name contain the specified string

To start using the Monitoring API, ensure you have received your Client ID and Client Secret.

• Proceed to the Authentication section of this documentation, which covers how to get a valid token.
• Once you have a token, you can start using the API. Each request to any of the API endpoints should contain the token as described in Accessing the Monitoring API with tokens.
• All the available endpoints with their parameters are listed further below in this document.

A simple client code snippet in Python for reference is maintained in this repository:
https://github.com/relex/monitoring-api-demo

This section covers the data resources and technical details of the RELEX Monitoring API.

⚠️ All API requests must be made over HTTPS

Calls made over plain HTTP will fail and return an HTTP Status Code 400 Bad Request.

• A resource is an object with a type, associated data, relationships to other resources, and a set of methods that operate on it. In practice, the resource most often maps to a corresponding database table, but not always.

The RELEX Monitoring API uses JSON as the format for data serialization. The JSON payload of the API has a root-level object that contains a meta-object and data array element.

All resources have a defined schema, and the details of each resource can be examined in the resource specifications in this document.

Date and time can be represented with a single field type expected to follow the ISO 8601 standard.

• date-time: With date and time combined. Format: yyyy-MM-ddThh:mm:ssZ, for example 2023-12-05T13:45:10Z.

The base URL for API requests depends on the region where the client is located. The following URLs should be used depending on the region:

Region	Base URL
EU	https://eu.monitor.relexsolutions.com
US	https://us.monitor.relexsolutions.com

Ensure that all API requests use the appropriate base URL for your region. For example, an API request for a customer in the EU would be:

GET https://eu.monitor.relexsolutions.com/api/v1/{customer_id}/events/file?env=test

For more examples, see the operations dropdown menu on the right side of the page.

Monitoring API resources respond to requests synchronously.

• Authentication is done synchronously and immediately when the client sends a request.
• The client receives a response with a 200 HTTP status code and the requested data if RELEX is able to accept the request successfully.
• If a non-2xx status code is returned, it indicates that RELEX's synchronous part has failed (500 status code) or the client's request is incorrect (4xx status code).

The RELEX Monitoring API uses standard HTTP response codes to indicate the various failures an API request can return. Codes in the 4xx range indicate an error on the client side, for example, the resource name was incorrect. Codes in the 5xx range indicate an error within RELEX services.

To convey details about errors to clients in JSON responses, the RELEX Monitoring API uses the RFC 7807 standard.

Error code	Description
400 Bad Request	The request was unacceptable, for example, due to a missing parameter
401 Unauthorized	The client must log in. This often means "Unauthenticated"
403 Forbidden	Authentication/authorization failed. The bearer token provided might be invalid, expired, or revoked, or the customer_id path parameter is incorrect
404 Not Found	Resource was not found
405 Method not allowed	The request method is not supported by the target resource
429 Too Many Requests	Request limit has been reached
500 Internal Server Error	Generic server error indicating an unexpected problem. A client may retry

The RELEX Monitoring API imposes limits on incoming web requests to ensure performance, reliability, and efficiency. The API sets the following limits:

Overall limit

Overall limit is 100,000 requests per 5 minutes from a single customer IP address. Applies to all endpoints and requests to the API.

/api/v{N}/{customer_id}/events/job endpoint limits

The limit for the /api/v{N}/{customer_id}/events/job endpoint is 100 requests per minute from a single customer IP address.

/api/v{N}/{customer_id}/events/file endpoint limits

The limit for the /api/v{N}/{customer_id}/events/file endpoint is 100 requests per minute from a single customer IP address.

/api/v{N}/health endpoint limits

The limit for the /api/v{N}/health endpoint is 12 requests per minute from a single customer IP address.

If the limits are exceeded, an HTTP status code 429 is returned.

Exceeding limits

ℹ️ API limits are subject to change and appropriate values are determined during the implementation project.

The RELEX Monitoring API imposes no limits on return payloads. The payload size can be arbitrarily large.

This section describes the authentication methods and security-related requirements for the Monitoring API.

The Monitoring API utilizes OAuth 2.0 and OpenID Connect (OIDC) for authentication and authorization. OIDC is an authentication layer on top of OAuth 2.0 and JSON Web Tokens (JWT).

The API is secured via a JWT access token, which must be present in each request. The JWT is fetched from a token endpoint of RELEX Identity (an Identity Provider) using a Client ID and a Client Secret.

The Monitoring API implements authorization using the Client Credentials Grant. It is an authorization flow defined in the OAuth 2.0 specification, which is typically used for allowing access to resources in an automated context; that is, in a context with no human input.

The general steps involved are as follows:

1. Pre-requisites: Obtain the information the client needs to request an access token, and configure it in the client application. This is a one-time step.
2. Authorization: The client application requests an Access Token from RELEX Identity using the information provided in step 1.
3. Access: The client includes the provided Access Token in its requests, which allows it to access the Monitoring API endpoints.

Pre-requisites

To authenticate with RELEX Identity, the client needs:

• A Client ID
• A Client Secret
• A RELEX Identity token endpoint URL

These are provided by RELEX during the implementation process. After this information has been provided, it needs to be configured into the client application according to the application's specific needs.

Token endpoint based on region

The token endpoint URL for obtaining the JWT access token depends on the region. The following URLs should be used depending on the region where the client operates:

Region	Token endpoint URL
EU	https://identity.prod-eu.prod.cc.relexsolutions.com/monitoring_api_prod/connect/token
US	https://identity.prod-us.prod.cc.relexsolutions.com/monitoring_api_prod/connect/token

1. The client sends a POST request to the provided RELEX Identity token endpoint

• Content type needs to be set to application/x-www-form-urlencoded
• The Client ID, Client Secret, and client_credentials grant type must be included in the POST body as URL-encoded key-value pairs.

An example body:

client_id=my_client&client_secret=ZWFzdGVyZWdnCg&grant_type=client_credentials

2. RELEX Identity authenticates the client.
3. If authentication is successful, RELEX Identity authorizes the client by responding with a JSON object that contains:

• "access_token": the JWT token that needs to be used for accessing the Monitoring API
• "expires_in": the access token's time to live in seconds
• "token_type": information on how the token needs to be used, in this case, always set to "Bearer".
• "scope": The scope that the token grants access to.

Whenever the client accesses any Monitoring API endpoint, the client must provide the following:

• A valid access token in an Authorization -header, preceded by Bearer. An example header is Authorization: Bearer eyJ[...]jw.

When an Access Token expires, Monitoring API calls respond with 401 Unauthorized The client application has two options to keep it authenticated:

• The client may handle 401 responses and react by initiating a new Client Credentials grant, as described in the "Authorization steps" section.
• The client may monitor the token's expiry interval. When the grant is about to expire, the client fetches a new token.

Note: the Client Credentials grant type is not compatible with a construct such as refresh tokens, as mentioned in the protocol specification.

Client configuration

In our example flow, we have the following client-specific information:

• Client ID: customer_id-monitoring-api
• Client Secret: ZWFzdGVyZWdnCg
• Token endpoint URL(assuming that client is based in EU): https://identity.prod-eu.prod.cc.relexsolutions.com/monitoring_api_prod/connect/token

For demonstration purposes, we'll use curl as a client.

Authorization

1. We POST our authorization request to the token endpoint.

% curl -vd "grant_type=client_credentials&client_id=customer_id-monitoring-api&client_secret=ZWFzdGVyZWdnCg" https://identity.prod-eu.prod.cc.relexsolutions.com/monitoring_api_prod/connect/token
[...]
> POST /monitoring_api_prod/connect/token HTTP/1.1
> Host: identity.prod-eu.prod.cc.relexsolutions.com
> Accept: */*
> Content-Type: application/x-www-form-urlencoded
[...]
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=UTF-8
[...]

As a response body, we get the following:

{"access_token":"eyJ[...]jw","expires_in":3600,"token_type":"Bearer","scope":"example-scope"}

2. We extract the access token from the response field of the "access_token".
3. We use this token to access an API resource. In our case /api/v1/customer_id/events/file:

% curl -H "Authorization: Bearer eyJ[...]jw" https://eu.monitor.relexsolutions.com/api/v1/customer_id/events/file
> GET /api/v1/customer_id/events/file HTTP/1.1
> Host: eu.monitor.relexsolutions.com
> Authorization: Bearer eyJ[...]jw
[...]
< HTTP/1.1 200 OK
[...]

As an additional layer of security, the Monitoring API can be configured to allow requests from only certain IP addresses or ranges. The recommendation is to always have an IP allowlist in place. The API does not support an explicit blocklist.

Endpoints for managing and retrieving customer-specific environment configurations.

Endpoints for fetching files and jobs event data.

⚠️ This endpoint is not yet available. The section below describes the planned metrics endpoint.

The Monitoring API exposes a Prometheus-compatible metrics endpoint at /api/v1/{customer_id}/metrics. The metrics available over this endpoint give quantitative insight into the throughput, latency, and reliability of data flowing into RELEX services.

When applicable, metrics are labelled with a type dimension that identifies the data type (e.g. sales, product_locations). The type values are normalised to use underscores.

These metrics describe the end-to-end data ingestion pipeline from the point data is received by RELEX until it is consumed by RELEX Plan, the core supply chain planning application. The metrics are technology-agnostic and apply regardless of whether data is ingested via batch file uploads or via the Data API.

Metric	Type	Unit	Description
plan_data_ingestion_delay_seconds	Gauge	seconds	End-to-end latency of RELEX Plan data ingestion, measured as the delay between data being sent to RELEX and data being consumed by RELEX Plan.
plan_data_ingestion_messages_total	Counter	messages	Total number of messages (files or records) ingested by RELEX Plan. Tracks overall ingestion throughput.
plan_data_ingestion_rows_total	Counter	rows	Total number of data rows processed by RELEX Plan during ingestion. Provides a fine-grained view of data volume beyond message counts.

Labels used with plan_data_ingestion_* metrics:

Label	Meaning
app	Which customer application the metric belongs to.
env	Which customer environment the application belongs to.
type	Which kind of integration data stream the metric describes.

These metrics follow OpenTelemetry semantic conventions and describe the HTTP layer of the RELEX Data API, for customers using that integration method.

Metric	Type	Unit	Description
http_server_request_duration_ms	Histogram	milliseconds	Duration of HTTP requests received by the Data API.
http_server_request_body_size_bytes	Counter	bytes	Cumulative size of HTTP request bodies received by the Data API. Indicates the volume of data being sent to RELEX.
http_server_response_body_size_bytes	Counter	bytes	Cumulative size of HTTP response bodies returned by the Data API.
http_server_request_count_by_status	Counter	requests	Total number of HTTP requests received by the Data API, broken down by HTTP status code (http_status label).

Labels used with http_server_request_duration_ms* metrics:

Label	Meaning
type	Which kind of integration data stream the metric describes.
http_path	Which API endpoint received the data in RELEX.
le	For bucket metrics, the upper time limit of the bucket in milliseconds. This label is not present on the related _sum and _count metrics.

Labels used with http_server_request_count_by_status:

Label	Meaning
type	Which kind of integration data stream the metric describes.
http_path	Which API endpoint received the data in RELEX.
http_status	Which HTTP response status RELEX returned, for example 200 or 400.

Labels used with http_server_request_body_size_bytes* and http_server_response_body_size_bytes* metrics:

Label	Meaning
type	Which kind of integration data stream the metric describes.
http_path	Which API endpoint received the data in RELEX for request size metrics, or which API endpoint RELEX sent the data from for response size metrics.

Endpoint that report on the Monitoring API operational and readiness status.