Data Factory Logs API

Introduction

A Data Factory log is a log entry created during the execution of a job. Logs are visible in the job execution details and can be used to track progress or report issues during a job execution.

The Data Factory Log API Swagger definition is available on our Product-Live API portal here.

General information

• Rate limit: 50 requests per minute

Create a Data Factory Log

Request URL

Path parameters

None

Request parameters

None

Request Headers

Header	Type	Description
accept	string	*/*
Content-Type	string	application/json
X-Api-Key	string	Your account API key
cid	string	The correlation ID of the job execution that produces the log. See how to retrieve the cid below

How to retrieve the cid

The cid (Correlation ID) is a unique identifier that links a log entry to a specific job execution. It is generated internally when a job execution is created.

When implementing a custom Task, the cid is available in the task execution input as the eventCorrelationId field. When your custom Task polls Data Factory and receives a task execution, extract the eventCorrelationId from the task execution's input and pass it as the cid header when creating logs.

TIP

If you want to create logs from within a job definition, you can use the data-log-create task directly. It will automatically resolve the cid from the job execution context, so you don't need to retrieve or pass it manually.

Request Body

Property	Type	Required	Description
message	string	Yes	The log message content
emitterName	string	Yes	The name of the emitter that produces the log
eventCorrelationId	string	Yes	A correlation ID to group related log entries
severity	string	No	The log severity level. Possible values: info, warning, error. Default: info
messageType	string	No	The message format type. Possible values: DEFAULT, MARKDOWN. Default: DEFAULT

{
    "message": "Import completed successfully",
    "emitterName": "My import job",
    "eventCorrelationId": "evt-123",
    "severity": "info",
    "messageType": "DEFAULT"
}

Request Example

curl -X 'POST' \
  'https://api.product-live.com/v1/data-factory/log' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>' \
  -H 'Content-Type: application/json' \
  -H 'cid: <CORRELATION_ID>' \
  -d '{
    "message": "Import completed successfully",
    "emitterName": "My import job",
    "eventCorrelationId": "evt-123",
    "severity": "info"
  }'

Response Example

{
    "object": "data_factory_log",
    "id": "6630a1b2c3d4e5f6a7b8c9d0",
    "createdAt": "2026-04-07T10:30:00.000Z",
    "code": "LOG",
    "severity": "info",
    "message": "Import completed successfully",
    "messageType": "DEFAULT",
    "accountId": "2629",
    "cid": "abc123-def456",
    "eventCorrelationId": "evt-123",
    "jobInstanceId": "658445e23ad5b929948ab731",
    "emitterName": "My import job"
}