Integration Action Log API (1.0.0)

Download OpenAPI specification:Download

API for managing integration action logs

Integration Action Log

Operations related to integration action log management

Get all integration action log records

Retrieve a list of all integration action log records with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new integration action log record

Create a new integration action log record with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
integrationId
required
string

Integration identifier

actionType
required
string
Enum: "create" "update" "delete" "sync" "webhook"

Type of action performed

entityType
required
string

Type of entity affected

entityId
string

ID of the affected entity

status
required
string
Enum: "pending" "success" "failed" "retrying"

Status of the action

object

Action payload data

object

Response data from the action

errorMessage
string

Error message if action failed

retryCount
integer >= 0
Default: 0

Number of retry attempts

executionTime
number

Execution time in milliseconds

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "actionType": "create",
  • "entityType": "product",
  • "entityId": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "status": "success",
  • "payload": { },
  • "response": { },
  • "errorMessage": "string",
  • "retryCount": 0,
  • "executionTime": 0,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get integration action log record by ID

Retrieve a specific integration action log record by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration action log record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update integration action log record

Update an existing integration action log record with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration action log record ID

Request Body schema: application/json
integrationId
required
string

Integration identifier

actionType
required
string
Enum: "create" "update" "delete" "sync" "webhook"

Type of action performed

entityType
required
string

Type of entity affected

entityId
string

ID of the affected entity

status
required
string
Enum: "pending" "success" "failed" "retrying"

Status of the action

object

Action payload data

object

Response data from the action

errorMessage
string

Error message if action failed

retryCount
integer >= 0
Default: 0

Number of retry attempts

executionTime
number

Execution time in milliseconds

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "actionType": "create",
  • "entityType": "product",
  • "entityId": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "status": "success",
  • "payload": { },
  • "response": { },
  • "errorMessage": "string",
  • "retryCount": 0,
  • "executionTime": 0,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete integration action log record

Delete an existing integration action log record

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration action log record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Integration action log record deleted successfully"
}