API Reference

Full Reference

Complete reference for every event the InfiniAnalytics event-tracking API supports -START, EVENT, WARNING, ERROR and END - all sent through the same POST /v1/register/ endpoint.

Description

The InfiniAnalytics API lets you track the executions of your organization's automated processes. An execution is built from the following events:

START - registers the start of an automation execution.
EVENT - registers a relevant event during the execution.
WARNING - registers a warning that occurred during the execution.
END - registers the end of the execution.
ERROR - registers a failure or exception that occurred during the execution.

This gives you a detailed, queryable record of everything that happens in every automation in your organization, for both real-time monitoring and later auditing.

Getting Started

Get your organization token - a secret string used to authenticate every endpoint. You can find it on the InfiniAnalytics dashboard, on the page where your organization is managed.
Identify your automation - every event is associated with an automation through its unique identifier, automation_id. If you don't have it, ask your platform administrator or check your automations list.
Decide an execution_id for the execution - a value that uniquely identifies the execution you're starting. It must be unique and cannot be reused by two concurrent executions. It can be an ID you already use internally, or a timestamp of the date/time the execution starts.
Make HTTPS requests - send data to the endpoints over HTTPS to keep the communication secure. Any plain HTTP request returns an HTTP 301 redirecting you to the HTTPS version.
Send and manage your events - use the main endpoint /v1/register/ to register the different event types of your execution (START, EVENT, WARNING, END, ERROR). If you want to check connectivity with the API before you start, call /v1/ping/.

Authentication

The InfiniAnalytics API requires an organization token on every call to the endpoints. Every POST request to /v1/register/ must include a token header set to your organization token. Without this token, or with an invalid one, you'll get an HTTP 401 Unauthorized.

Example header:

http

token: your_organization_token
Content-Type: application/json

Server Errors

An HTTP 500 or similar indicates the server is experiencing unusually high load or a temporary issue. If it persists, or you receive other 5XX errors, contact InfiniAnalytics support.

Register execution start

POST/v1/register/

Registers the start of an execution. This should be the first event sent for a given execution_id.

Request body fields

Field	Required	Description
`automation_id`	Yes	The UUID of your automation in the InfiniAnalytics platform.
`execution_id`	Yes	Unique identifier for the execution you are starting. Can be your own system ID or a timestamp.
`event`	Yes	Event type to register, in this case `START`.
`description`	No	Free text describing the execution that is starting.

Example request body:

json

{
  "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "event": "START",
  "description": "Starting the execution"
}

Example cURL request:

bash

curl --location 'https://api.analytics.infini.es/v1/register/' \
  --header 'Content-Type: application/json' \
  --header 'token: your_organization_token' \
  --data '{
    "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
    "execution_id": "2025-03-03T15:32:17.571404",
    "event": "START",
    "description": "Starting the execution"
  }'

Example response (HTTP 201):

json

{
  "automation": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "type_of_event": "START",
  "description": "Starting the execution",
  "error_id": "",
  "error_description_detail": "",
  "created_at": "2025-03-03T16:00:29.998530Z"
}

Register execution event

POST/v1/register/

Registers a relevant event that occurred during the execution - useful for logging progress or milestones mid-run, without marking the execution as finished, warned or failed.

Request body fields

Field	Required	Description
`automation_id`	Yes	The UUID of your automation in the InfiniAnalytics platform.
`execution_id`	Yes	Unique identifier for the execution. Must match the execution_id used in its START event.
`event`	Yes	Event type to register, in this case `EVENT`.
`description`	No	Free text describing the event.

Example request body:

json

{
  "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "event": "EVENT",
  "description": "Relevant event description"
}

Example cURL request:

bash

curl --location 'https://api.analytics.infini.es/v1/register/' \
  --header 'Content-Type: application/json' \
  --header 'token: your_organization_token' \
  --data '{
    "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
    "execution_id": "2025-03-03T15:32:17.571404",
    "event": "EVENT",
    "description": "Relevant event description"
  }'

Example response (HTTP 201):

json

{
  "automation": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "type_of_event": "EVENT",
  "description": "Relevant event description",
  "error_id": "",
  "error_description_detail": "",
  "created_at": "2025-03-03T16:00:29.998530Z"
}

Register execution warning

POST/v1/register/

Registers warnings that can occur in your automation - not severe enough to fail the execution, but worth keeping track of.

Request body fields

Field	Required	Description
`automation_id`	Yes	Must be your automation ID, in UUID format.
`execution_id`	Yes	Unique identifier for the execution. Can be your own system ID or a timestamp.
`event`	Yes	Event type to register, in this case `WARNING`.
`description`	No	Text describing the warning to register.

Example request body:

json

{
  "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "event": "WARNING",
  "description": "Warning description"
}

Example cURL request:

bash

curl --location 'https://api.analytics.infini.es/v1/register/' \
  --header 'Content-Type: application/json' \
  --header 'token: your_organization_token' \
  --data '{
    "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
    "execution_id": "2025-03-03T15:32:17.571404",
    "event": "WARNING",
    "description": "Warning description"
  }'

Example response (HTTP 201):

json

{
  "automation": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "type_of_event": "WARNING",
  "description": "Warning description",
  "error_id": "",
  "error_description_detail": "",
  "created_at": "2025-03-03T16:00:29.998530Z"
}

Register execution error

POST/v1/register/

Registers errors that can occur in your automation. Registering an error on an execution makes it be recorded as failed.

Request body fields

Field	Required	Description
`automation_id`	Yes	Must be your automation ID, in UUID format.
`execution_id`	Yes	Unique identifier for the execution. Can be your own system ID or a timestamp.
`event`	Yes	Event type to register, in this case `ERROR`.
`description`	No	Text describing the execution at a high level.
`error_id`	No	An error identifier, if any. Can be entered manually or automatically if your language or platform allows it.
`error_description`	No	Detailed error message, usually provided by your automation's language or platform.

Example request body:

json

{
  "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "event": "ERROR",
  "description": "High-level error description",
  "error_id": "e0001",
  "error_description": "Detailed error description"
}

Example cURL request:

bash

curl --location 'https://api.analytics.infini.es/v1/register/' \
  --header 'Content-Type: application/json' \
  --header 'token: your_organization_token' \
  --data '{
    "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
    "execution_id": "2025-03-03T15:32:17.571404",
    "event": "ERROR",
    "description": "High-level error description",
    "error_id": "e0001",
    "error_description": "Detailed error description"
  }'

Example response (HTTP 201):

json

{
  "automation": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "type_of_event": "ERROR",
  "description": "High-level error description",
  "error_id": "e0001",
  "error_description_detail": "Detailed error description",
  "created_at": "2025-03-03T16:00:29.998530Z"
}

Register execution end

POST/v1/register/

Registers the end of an execution. If no ERROR event was previously registered, the execution is counted as successful.

Request body fields

Field	Required	Description
`automation_id`	Yes	Must be your automation ID, in UUID format.
`execution_id`	Yes	Unique identifier for the execution. Can be your own system ID or a timestamp.
`event`	Yes	Event type to register, in this case `END`.
`description`	No	Text describing the execution that is finishing.

Example request body:

json

{
  "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "event": "END",
  "description": "End of execution description"
}

Example cURL request:

bash

curl --location 'https://api.analytics.infini.es/v1/register/' \
  --header 'Content-Type: application/json' \
  --header 'token: your_organization_token' \
  --data '{
    "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
    "execution_id": "2025-03-03T15:32:17.571404",
    "event": "END",
    "description": "End of execution description"
  }'

Example response (HTTP 201):

json

{
  "automation": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "type_of_event": "END",
  "description": "End of execution description",
  "error_id": "",
  "error_description_detail": "",
  "created_at": "2025-03-03T16:00:29.998530Z"
}