Commerce

Report daily engagement

Reports one day's numbers for an activity (UTC day), shown next to it in the store's Marketing section.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

post/v1/messaging/commerce/marketing-activities/{remoteId}/engagements

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/commerce/marketing-activities/{remoteId}/engagements
  • Auth: HTTP bearer

Path parameters

remoteIdstring required

The remoteId given when recording it.

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

datestring date required
likesinteger
viewsinteger
clicksinteger
sharesinteger
adSpendstring

Decimal in the store currency.

commentsinteger
accountIdstring required
impressionsinteger

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.