Create Compass Offline Export Task

POST

/affiliate_seller/202603/compass/offline_task

Create an asynchronous offline export task for the specified doc_type and plan_type within a given time window. Returns a task_id for subsequent status query and file download.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

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

Request Body

Media typeapplication/json

object

module_type

Type of Compass data to export. Allowed values:

• CREATOR: Creator list data.
• BASE: Core performance data.

string

Allowed values: CREATOR BASE

window_type

Time window included in the export, ending on end_day. Allowed values: PAST_24H, PAST_7_DAYS, PAST_30_DAYS.

string

Allowed values: PAST_24H PAST_7_DAYS PAST_30_DAYS

end_day

End date in the local timezone of the specified region, formatted as YYYYMMDD.

• id：UTC+7
• my：UTC+8
• sg：UTC+8
• vn：UTC+7
• th：UTC+7
• ph：UTC+8
• sa：UTC+3
• us：UTC-8
• mx：UTC-6
• br：UTC-3
• jp：UTC+9
• gb：UTC+0
• ie：UTC+0
• es：UTC+1
• de：UTC+1
• fr：UTC+1
• it：UTC+1
• pl：UTC+1
• nl：UTC+1
• be：UTC+1
• cz：UTC+1
• at：UTC+1
• gr：UTC+2
• pt：UTC+0
• hu：UTC+1

integer format: int64

plan_type

Plan type. Allowed values: ALL, TARGET, OPEN, PARTNER.

string

Allowed values: ALL TARGET OPEN PARTNER

Example

{
  "module_type": "BASE",
  "window_type": "PAST_24H",
  "end_day": 20260301,
  "plan_type": "ALL"
}

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

The task for creating downloadable files

object

id

The id of the task.

string

Example

{
  "code": 0,
  "data": {
    "task": {
      "id": "1234"
    }
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}