Get a beacon configuration

You need the API Key for your mPulse app, as well as the additional required fields covered below. This operation gets the data needed in order to run the Send a Beacon operation, such as h.key, h.d, h.t, h.cr and beacon_url. You need to run this operation before you can send a beacon.

Query Params
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.

string
required

The mPulse App Domain.

string

Previously used beacon URL. Only used on a Config Refresh API request. Should be the value of beacon_url from the first Config response.

string

Only used on a Config Refresh API request. Used to get a new Anti Cross-Site-Request-Forgery (Anti-CRSF) token h.cr.

Headers
string
required

If you use a tool like curl, you may need to spoof the User-Agent string. Any mPulse apps configured with Include Bot Beacons un-checked reject requests from curl.

Responses

Language
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json