Skip to content

Delivery analysis detail

POST/v1/api/douyin/douplus/analyse-detail

DOU+ delivery analysis detail (per-order / per-item metric list with paging & sorting); account/video/live by query.analysisType Requires a valid www.douyin.com web Cookie

Request body

Call this sync operation at its vendor-qualified URL. The model identity is encoded in the path; only operation-specific input fields belong in the request body.

stringcookierequired

User www.douyin.com web Cookie

objectqueryrequired

Analysis query object. Key fields: startTime and endTime (timestamps in seconds); analysisType (1=account, 2=video, 3=live); authorSecIdList (account sec_uid list); statusList (delivery status filters); metrics (metric list, for example stat_cost, total_play, total_like, dy_comment, dy_share, dy_follow); SecondaryTargetIds; CollectWayIds. Graph requests also use dimension; detail requests also use page, limit, orderByMetric, and orderByType; video and live analysis also use liveRoomIdList.

Optional<integer>query.analysisType

Request parameter supported by this operation.

Allowed values: 1, 2, 3

Optional<array<string>>query.authorSecIdList

Request parameter supported by this operation.

Optional<array<object>>query.CollectWayIds

Request parameter supported by this operation.

Optional<string>query.endTime

Request parameter supported by this operation.

Pattern: ^[0-9]{10}$

Optional<integer>query.limit

Request parameter supported by this operation.

Minimum: 1

Optional<array<string>>query.metrics

Request parameter supported by this operation.

Optional<string>query.orderByMetric

Request parameter supported by this operation.

Optional<integer>query.orderByType

Request parameter supported by this operation.

Optional<integer>query.page

Request parameter supported by this operation.

Minimum: 1

Optional<array<object>>query.SecondaryTargetIds

Request parameter supported by this operation.

Optional<string>query.startTime

Request parameter supported by this operation.

Pattern: ^[0-9]{10}$

Optional<array<object>>query.statusList

Request parameter supported by this operation.

Response Schema

A synchronous completed response contains exactly one outputs item with only data. Failed and timeout responses contain error and never outputs.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

stringmodelrequired

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Contains exactly one item whose only field is data.

Optional<object | array>outputs[0].data

Operation-specific business payload. This reference uses an empty object when no safe example can be confirmed.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

API capabilities

array<string>capability_tagsrequired

Capabilities declared by the API registry.

Default: api, douyin

stringexecution_moderequired

Execution mode declared by the API registry.

Default: sync

pending response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"pending","model":"douyin/douplus/analyse-detail"}

running response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"running","model":"douyin/douplus/analyse-detail"}

completed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"completed","model":"douyin/douplus/analyse-detail","outputs":[{"data":{}}]}

failed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"failed","model":"douyin/douplus/analyse-detail","error":{"type":"upstream_error","message":"upstream request failed"}}

timeout response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"timeout","model":"douyin/douplus/analyse-detail","error":{"type":"upstream_error","message":"upstream request failed"}}