Send a beacon

post

https://{hostnamePath}/

Send performance data to mPulse. To send a beacon, you need to first run the Get a beacon configuration operation. From the response, you can use the beacon_url to send a beacon.

See What is in an mPulse beacon for the full list of available beacon parameters.

Form Data

api

integer

required

1 to 1

A value of 1 indicates that a beacon was sent via API. Otherwise this object member is absent.

api.v

integer

Indicates the Beacon API version.

h.ab

string

Specifies the test bucket the visitor was in when they sent the beacon.

h.cr

string

required

This is the same value as the h.cr response parameter value from the Get a beacon configuration operation.

h.d

string

required

An mPulse App Domain. This is the same value as the h.d response parameter value from the Get a beacon configuration operation.

h.key

string

required

The mPulse App API Key, which can be found in the mPulse UI, under the General tab of the Configure Web App dialog.

h.pg

string

Page group name used for grouping and filtering events by page group in the mPulse application.

h.t

integer

required

This is the same value as the h.t response parameter value from the Get a beacon configuration operation.

rt.end

integer

required

Unix epoch timestamp that marks when an event occurred, expressed in milliseconds.

rt.si

string

A session identifier. Could be user defined or the same the session_id response parameter value from the Get a beacon configuration operation could be used.

rt.sl

integer

The session length (number of page views) when a beacon for the current event is sent.

rt.ss

integer

Unix epoch timestamp that marks when a session started, expressed in milliseconds.

rt.start

string

required

Specifies the method used to determine the start time. Use manual when sending a beacon via this API.

string

Beacon URL.

Response

204

Indicates the beacon was sent. The API always returns an empty response even if a beacon doesn't contain valid data, for security reasons.