Get Engagement Task Performances

POST

/customer_engagement/202412/performances

Retrieve detailed performance metrics for a customer engagement task, including message reads, order conversions, and other key engagement statistics.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Request Body^required

Media typeapplication/json

object

task_ids

required

The customer engagement task IDs for which to retrieve performance data. Provide 1 to 50 IDs; each ID must be a base-10 string that fits in a signed 64-bit integer.

Array<string>

Example^generated

{
  "task_ids": [
    "example"
  ]
}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

task_performances

The requested list of task performance.

Array<object>

object

id

The customer engagement task ID for this performance record.

string

status

The status of the task. Possible values:

• UNKNOWN: The task status is unknown.
• DRAFT: The task is in draft status.
• WAITING: The task is waiting.
• SENDING: The task is sending messages.
• FAILED: The task failed to send messages.
• CANCELED: The task was canceled.
• SUCCESS: The task completed successfully.
• DELETED: The task was deleted.

string

Allowed values: UNKNOWN DRAFT WAITING SENDING FAILED CANCELED SUCCESS DELETED

sent_recipient_count

The number of users that received the message.

integer format: int64

read_recipient_count

The number of users that read the message.

integer format: int64

order_count

The number of orders resulting from the message.

integer format: int64

gmv_amount

The revenue from the converted orders.

string

claimed_coupons_count

The number of coupons claimed.

integer format: int64

Example

{
  "code": 0,
  "data": {
    "task_performances": [
      {
        "id": "8646958016719848812",
        "status": "SENDING",
        "sent_recipient_count": 100,
        "read_recipient_count": 20,
        "order_count": 10,
        "gmv_amount": "5.50",
        "claimed_coupons_count": 1
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}