KEkeboola
Events

Events list

For admin tokens will endpoint lists all events in the project. For non-admin tokens will list only events created by the token.

Virtually every interaction of the client (an API call) creates an Event. Apart from that, external events may also be added via an API. Events are stored for a limited time.

Id field is deprecated and will be removed in the future. Please use Uuid instead.

Events can be filtered by various filters:

  • sinceId, maxId - Events newer or older than the passed id or Uuid (id is deprecated and will be removed in the future)
  • component - Component name
  • configurationId - Configuration id
  • runId - Run id
  • q - Advanced search using a query string. Query string syntax

The events pagination uses two parameters:

  • limit - Number of returned events. The default value: 100
  • offset - Pagination offset

The branch variant lists events of the given Development Branch; default can be used as branchId to emulate the call without a development branch, i.e. GET /v2/storage/events is the same as GET /v2/storage/branch/default/events.

get/v2/storage/events

Request

Query parameters

sinceIdstring

Shows only events after the specified Id or Uuid (id is deprecated and will be removed in the future).

maxIdstring

Shows only events before the passed Id or Uuid (id is deprecated and will be removed in the future).

componentstring

Shows only events emitted by the specified component.

configurationIdstring

Shows only events related to the given configuration Id.

runIdstring

Shows only events with the specified run Id.

qstring

Searches events using advanced Query string syntax.

limitinteger

Pagination limit. Maximum allowed value is 10000.

offsetinteger

Pagination offset.

sortOrder'asc' | 'desc'

Sort order of events: asc = oldest first, desc = newest first.

Response

List of events.

uuidstring required

Event UUID v7 identifier.

eventstring required

Event identifier such as storage.tableImportDone or storage.tableDetail. External events are named ext.{component}.{configurationId}.

componentstring required

Name of the component that logged the event. Events can be logged by the storage component or any other registered component.

messagestring required

Human readable description of the event.

descriptionstring required

Additional description of the event, such as a detailed error description.

type'info' | 'success' | 'warn' | 'error' required

Type of the event.

runIdstring nullable required

Id of the associated job.

createdstring required

When the event was created, ISO 8601 with a +hhmm offset; "" when none was recorded.

configurationIdstring nullable required

Id of a configuration used by an external component.

objectNamestring required

Name of the target object, e.g. table name for storage.tableImportDone.

objectTypestring required

Type of the target object, e.g. table for storage.tableImportDone.

paramsobject required

Arbitrary parameters associated with the event, e.g. CSV file settings for table import.

resultsobject required

Arbitrary results of the event.

performanceobject required

Arbitrary performance metrics associated with the event.

idBranchinteger nullable required

Id of the branch the event belongs to, including the default branch; null when the event is not tied to a branch.

uristring required

Event URI.

Example response

[
  {
    "uuid": "01958f48-b1fc-7f05-b9b9-8a4a7b385bc3",
    "event": "storage.workspaceLoaded",
    "component": "storage",
    "message": "Table in.c-application-testing.cashier-data was loaded to the workspace workspace_78423 as my-table.",
    "type": "info",
    "created": "2017-02-13T12:01:05+0100",
    "objectName": "cashier-data",
    "objectType": "table",
    "context": {
      "remoteAddr": "203.0.113.10",
      "httpUserAgent": "Keboola Storage PHP Client",
      "httpUserAgentOriginal": "Keboola Storage PHP Client",
      "authorization": "token",
      "apiVersion": "v2"
    },
    "token": {
      "id": 1234,
      "name": "support@keboola.com"
    },
    "idBranch": 1234,
    "uri": "https://connection.keboola.com/v2/storage/events/01958f48-b1fc-7f05-b9b9-8a4a7b385bc3",
    "attachments": [
      {
        "id": 6789,
        "uploadType": "userUpload",
        "created": "2017-02-13T12:01:05+0100",
        "name": "backup.csv.gz",
        "url": "https://s3.amazonaws.com/kbc-sapi-files/exp-15/1234/files.keboola/backup.csv.gz",
        "sizeBytes": 1024
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.