This can be used to send multiple event types in a single request.

Published on Dec 18, 2024

1 minute(s) read

Prev Next

Post

/customers/{customerId}/users/{userId}/batch

Security

API Key

Header parameter nameaccess_token

Access token Authentication

Path parameters

customerId

stringRequired

userId

stringRequired

Body parameters

Array of object

object

rec

string

Default parameter to send with event payload

Example1

idsite

string

The tracking_id of the site

Example1234

url

string

The URL of the page

Examplehttps://example.com

urlref

string

The referrer URL

Examplehttps://example.com

locale

string

The locale of the user

Exampleen_US

uid

string

A string representation of the user object

Example{"customer_id":"customer_id","user_type":"return_user","testing_group_name":"Inactive","session_id":"524e0542-5713-4755-a8c0-1430cbd58aa9"}

c_p

string

The product_id. Used for events such as product_view, product_add, product_purchase, etc.

Example1234

c_n

string

The ID of the element or deployment to track

Examplesm_el_1234

c_t

string

A comma separated list of products

Example1234,5678,9012

c_i

string

A description of the event type

ExamplesearchResult

cvar

string

A string representation of a JSON object containing information about the product. _pkp is the product's price, _pks is the product's sku, _pkn is the product's name, _pkc is the product's currency.

Example{"2":["_pkp",1000],"3":["_pks","1234"],"4":["_pkn","product_name"],"5":["_pkc","{"currency_code":"USD"}"]}

ec_items

string

A string representation of a JSON array containing information about the products. Index 0 is the product's sku, index 1 is the product's name, index 2 is the product's currency, index 3 is the product's price, and index 4 is the product's quantity.

Example[["1234","Product Name","{"currency_code":"usd"}",1000,1]]

ec_id

string

The Order ID. Should be sent with purchase events.

Example1234

revenue

number

The revenue. Should be sent with purchase events.

Example1000

context

object

A JSON object of context data. Used to pass dynamic, additional data to the tracker.

Example{ "key1": "value1", "key2": 1000, "nested": { "key": "value" }, "array": [ "1", "2", "3" ] }

query_id

string

Used for search events. The query id is sent to the tracker to be able to identify and group search events.

Example4893e2d0-2a35-4c58-81b6-ad3906518563

action_name

string

The name of the action that was performed.

Examplecontent_tracking

action_detail

string

Details on the action that was performed.

Examplesearch_result

action_type

string

The meta action that was performed.

Examplesearch_service

e_c

string

The category of the event

ExampleError tracking

e_a

string

The action type of the event. Used to send a message or description.

ExampleAn error occurred

e_n

string

The name of the event

ExampleTypeError:...

e_v

string

The value of the event

ExampleError tracking

ec_st

number

The total revenue

Example1000

ec_tx

number

The total tax

Example1000

ec_dt

string

The total discount

Example100

idgoal

string

The goal ID

Example0

version

string

The version of the event

Example2

Responses

200

Successful response

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal server error