Skip to main content
POST
Save a profile setup session

Authorizations

X-API-Key
string
header
required

API key for authentication. Get your key from the API Keys page.

Path Parameters

profileId
string
required

Browser Context Profile ID

Minimum string length: 1
Example:

"prof_abc123def4567890"

Body

application/json
session_id
string
required
Minimum string length: 1
Example:

"br-a1b2c3d4-e5f6-7890-abcd-ef1234567890"

signed_in_sites
string[]

Sites the user says they signed into during this setup, as hosts or URLs. Each is recorded as signed in only if this save wrote cookies for it; for sites TinyFish can check, its sign-in cookie must be saved too. Ignored when sign-in tracking is not enabled for the account.

Maximum array length: 20
Maximum string length: 253
Example:

Response

Save a profile setup session succeeded.

domains_updated
string[]
required
Example:
domains_failed
string[]
required
Example:
Required range: x >= 0
Example:

12

domains_skipped
object
required
pages_captured
integer
Required range: x >= 0
Example:

1

target_reads_skipped
integer
Required range: x >= 0
Example:

0

cleanup_failed
boolean
Example:

false

cleanup_kind
string
Example:

"post_save"

signed_in_sites
string[]

Sites this save recorded as signed in, from sign-in cookies set during setup. Omitted when sign-in tracking is not enabled for the account.

Example:
sign_in
object

Whether TinyFish saw a sign-in to the site setup started on. unverifiable when it cannot tell. Omitted when sign-in tracking is not enabled for the account.

Example:
user_confirmed_sites
object

Present when the request sent signed_in_sites and sign-in tracking is enabled for the account: the registered domains recorded as signed in, and the sites rejected with a reason.

Example: