action biapi_get_connections_id_connection_logs {
label: "Get connection logs"
description: "Get logs about connections.
"
provider: biapi
method: GET
path: "/connections/{id_connection}/logs"
encoding: json
input: {
type: "object"
properties: {
connector_uuid: {
type: "string"
}
error: {
type: "string"
}
expand: {
type: "string"
}
id_connection: {
type: "integer"
}
id_connector: {
type: "integer"
}
id_max: {
type: "integer"
}
id_source: {
type: "integer"
}
id_user: {
type: "integer"
}
limit: {
type: "integer"
}
max_date: {
type: "string"
format: "date"
}
min_date: {
type: "string"
format: "date"
}
offset: {
type: "integer"
}
period: {
type: "string"
}
}
required: ["id_connection"]
additionalProperties: false
}
output: {
type: "object"
required: ["connectionlogs"]
properties: {
connectionlogs: {
type: "array"
items: {
type: "object"
required: ["id", "id_connection", "timestamp"]
properties: {
error: {
type: "string"
description: "If fail, contains the error code"
}
error_message: {
type: "string"
description: "If fail, error message received from connector"
}
error_uid: {
type: "string"
description: "MD5 hash of the exception backtrace"
}
fields: {
type: "string"
description: "Fields for connection in additionalInformationNeeded state with background option"
}
id: {
type: "integer"
description: "ID of the log"
}
id_connection: {
type: "integer"
description: "ID of the connection"
}
id_connector: {
type: "integer"
description: "ID of the connector"
}
id_source: {
type: "integer"
description: "ID of the related connection source"
}
id_user: {
type: "integer"
description: "ID of the user"
}
login: {
type: "string"
description: "bcrypt hash of the login"
}
nb_accounts: {
type: "integer"
description: "In case of bank connection, number of accounts"
}
next_try: {
type: "string"
format: "date-time"
description: "If fail, the date represents the next try to connect"
}
session_folder_id: {
type: "string"
description: "Session folder uid"
}
start: {
type: "string"
format: "date-time"
description: "Timestamp when the synchronization has started"
}
statut: {
type: "integer"
description: "Status of user (1 = charged user)"
}
timestamp: {
type: "string"
format: "date-time"
description: "Timestamp of log, when the synchronization has finished"
}
worker: {
type: "string"
description: "Worker used to do synchronization"
}
}
}
}
total: {
type: "number"
description: "total number of results"
}
}
}
}