Tracking

Send a test event

Sends one test event for a site through the same ingest path as its tracking, flagged internal like staff and QA traffic (it can still show in the events list). Then verify tracking with that event name: if it arrives, ingest accepts the site and its key. It does not show that the site's own pages send events. Default event name ol_test_event.

post/sites/{site}/test-events

Request

  • Base URL: https://api.onelence.com/v1
  • URL: https://api.onelence.com/v1/sites/{site}/test-events
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.onelence.com/oauth/authorize, token URL https://api.onelence.com/oauth/token, scopes: tracking:write)
    • HTTP bearer

Path parameters

sitestring required

Site domain (e.g. example.com) or site id. Defaults to the workspace's newest active site.

Query parameters

dry_runboolean

true returns a preview of the change and applies nothing.

Headers

Idempotency-Keystring

8 to 200 visible ASCII characters. Retries with the same key and request return the stored response for 24 hours.

Request body

event_namestring

Default ol_test_event.

Response

With dry_run=true: what would change. Nothing is applied.

object'preview' required
capabilitystring required

Changes

No recorded changes to this operation across all 1 revision of this API.