KEkeboola
Events

Event detail

Obtains information about a event in the project. The branch variant returns the event of the given Development Branch.

For non-admin tokens, events bound to a bucket are only returned when the token has access to that bucket.

get/v2/storage/branch/{branchId}/events/{eventId}

Request

Path parameters

eventIdstring required

Event Id or uuid (id is deprecated and will be removed in the future).

branchIdstring required

Response

Event detail.

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.