API Reference

Starts a new collector test session.

post
https://platform.routy.app/api/v1/collector/test/start

Requires the AccountAdmin policy. Hidden in production environments
(HideInProduction). Creates a test session for a website/asset key so the collector script can
report results back. The success body is a StartTestSessionResponse with the test id, test url
and expiry.

🔐 Required permission: AccountAdmin

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Website url, asset key and optional configuration for the test.

Request to start a collector test session.

string | null

The website url to run the collector tests against.

string | null

The asset key identifying the tracking pixel under test.

configuration
object | null

Optional free-form test configuration key/value pairs.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago