Skip to main content
POST

Authorizations

X-Api-Key
string
header
required

Customer API key issued from the Roolink dashboard.

Body

application/json

The session the sensor is for. The User-Agent and URL must match the client that posts it.

userAgent
string
required

Session user agent.

url
string<uri>
required

Target page URL. Must include https://.

Example:

"https://target.example.com/"

flags
string

Optional. Flag string, when the site's script uses one.

_abck
string

Current _abck cookie value. Empty string on the first request.

bm_sz
string

Current bm_sz cookie value. Empty string on the first request.

sec_cpt
boolean
default:false

Set true when the site has already issued a Sec-CPT challenge in this session.

index
integer

Attempt number, counting from 0, when stepper is true.

stepper
boolean
default:false

Continue the same visitor across posts. Set true and count index up per post.

keyboard
boolean
default:false

Include synthetic keyboard events in the sensor.

language
string

Accept-Language value the session sends.

Example:

"en-US"

scriptData
object

The parsed-script values returned by POST /parse. Pass through unchanged.

scriptUrl
string<uri>

The script URL from the page. Post the returned sensor there.

Response

Sensor generated.

sensor
string
required

Sensor payload. Post it to scriptUrl on the site.