Events APIs

Get an Excel file with the user events logged in Spark. This is equivalent to the Event viewer Download Events.

Authorization

• Bearer {token} accessible from Authorization - Bearer token or systematically via Client Credentials.

  • The request headers should include a key for Authorization with the value Bearer {token}.

POST log job

Returns: status response with id of the requested job.

POST /{tenant}/api/v4/events/download

Path parameters

Key	Value
tenant *	Tenant is part of your Log in to Spark URL and also available in the User menu.

Request body

Content-Type: application/json

Key	Value
page_no	Page number of the list to get.
pageSize	Number of records per page.
sort_column	String defining the sort column. Example: -updated
sort_order	asc or desc sets the sort order for the sort_column. Example: desc
search	Array of search filter objects. Search filter objects can include: column Name of the column to filter. Columns include folderId, event_types (Array), service_name, user_name , event_start_date, event_end_date, value Value of the column to filter. operator Applies to numeric properties. Example 1: {"column": "folderId", "value": "8bc193d8-5f82-49d1-8da8-d689f6ab163f"} Example 2: { "column": "event_types", "value": ["PublishEngine", "DownloadEngine"]" } Example 3: {"column": "event_end_date", "value", "2026-03-02T15:08:00.000Z"}

Sample request

{
    "page_size": 10,
    "page_no": 1,
    "sort_column": "folder",
    "sort_order": "asc",
    "search": [
        {
            "column": "folder_id",
            "value": "8bc193d8-5f82-49d1-8da8-d689f6ab163f"
        },
        {
            "column": "service_name",
            "value": "AllInputTypes"
        },
        {
            "column": "event_start_date",
            "value": "2026-01-31T15:08:00.000Z"
        },
        {
            "column": "event_end_date",
            "value": "2026-03-02T15:08:00.000Z"
        },
        {
            "column": "user_name",
            "value": "[email protected]"
        },
        {
            "column": "event_types",
            "value": "[\"PublishEngine\",\"DownloadEngine\"]"
        }
    ]
}

Sample response

HTTP 200 OK Content-Type: application/json

{
    "object": "events",
    "id": "19caf63c-76e7-3c8c-b624-9a8a6c8a7293",
    "status_url": "https://excel.myenvironment.coherent.global/mytenant/api/v4/events/download/19caf63c-76e7-3c8c-b624-9a8a6c8a7293/status"
}

GET log job status

Returns: status response and download_url to download the ZIP file.

GET /{tenant}/api/v4/events/download/{jobId}/status

Authorization

Follows from Authorization above.

Path parameters

Key	Value
{tenant} *	Tenant is part of your Log in to Spark URL and also available in the User menu.
{jobId} *	job_id associated from POST log job.

Sample response

HTTP 200 OK Content-Type: application/json

{
    "object": "events",
    "id": "19caf63c-76e7-3c8c-b624-9a8a6c8a7293",
    "status_url": "https://myenvironment.coherent.global/mytenant/api/v4/events/download/19caf63c-76e7-3c8c-b624-9a8a6c8a7293/status",
    "response_timestamp": "2026-03-03T12:41:44.391Z",
    "status": "Success",
    "process_time": 8697,
    "outputs": {
        "files": [
            {
                "file": "https://environment.coherent.global/coherent_events_2026_03_03_T_12_40_40.xlsx",
                "file_hash": null
            }
        ]
    },
    "error": null,
    "source_system": "SPARK",
    "correlation_id": ""
}