Create Application

Provision an application: one embed whose collection config applies to every domain it runs on, with the concrete Site for each beacon resolved at ingest by the page-URL host. Sites are added by adopting/assigning domains (or auto-provision).

Authentifizierung

bearerAuth

AuthentifizierungBearer <token>

API token generated from the fastmon dashboard (Account → API Token). Send as Authorization: Bearer fm_... or paste the full token (including the fm_ prefix) into the Authorize dialog.

In: header

Pfad-Parameter

org_id*Org Id

Formatuuid

Request-Body

application/json

Provision an application (a tracking embed). The collection config applies to every domain the app is embedded on. data_retention_days / store_stitch / count_visitors_by are the per-domain DEFAULTS its member sites inherit (a site can override).

name?Name

Lengthlength <= 255

Default"Default"

environment?Environment

Deployment environment of an application. Billing-relevant: PROD apps are billed, DEV apps are not (see the billing module). Defaults to PROD — the revenue-safe fallback, so a forgotten value is never silently unbilled.

Default"prod"

Value in

"prod"
"dev"

data_retention_days?Data Retention Days

Default90

store_stitch?Store Stitch

Defaultfalse

count_visitors_by?VisitorIdentity

Which identifier the visitors metric defaults to in reports (the count_visitors_by field). A REPORTING preference, deliberately separate from the store_stitch/collect_sessions COLLECTION flags (those decide whether the data exists at all). The query-time resolver clamps this to what the site actually stores, and a per-query identity param overrides it. See resolve_identity().

Default"stitch"

Value in

"stitch"
"session"

site_policy?SitePolicy

How an application handles an UNKNOWN beacon hostname (one with no matching registered Site). Replaces the old auto_provision_sites flag and the per-Site enforce_domain_match.

OPEN — record a discovery suggestion, drop the beacon (default). AUTO — auto-create a Site for the hostname. STRICT — drop; no suggestion, no auto-provision, no one-site lenient bind (only exactly-registered domains are served).

Default"open"

Value in

"open"
"auto"
"strict"

collect_sessions?Collect Sessions

Defaultfalse

collect_fetch_xhr?Collect Fetch Xhr

Defaultfalse

session_consent?SessionConsent

When the served bundle writes the session identifier under consent (only meaningful when collect_sessions is on).

DEFERRED — defer the session write until window.fastmon.grantConsent() is called (consent-first; the privacy-safe default). IMMEDIATE — write the session on load (consent already handled / not required).

Default"deferred"

Value in

"deferred"
"immediate"

collect_error_messages?Collect Error Messages

Defaultfalse

collect_error_frames?Collect Error Frames

Defaultfalse

collect_query_keys?Collect Query Keys

Defaultfalse

collect_query_values_for?array<string>

Itemsitems <= 20

pagetype_ruleset?Pagetype Ruleset

Default""

preset?string|null

collector_mode?CollectorMode

How the served tracker bundle is told where to POST beacons.

DEFAULT → fastmon's shared collector (settings.COLLECTOR_URL); third-party. CUSTOM → an explicit absolute collector_endpoint URL. Covers both a first-party setup on the customer's own domain AND a third-party custom collector host — the browser decides 1P/3P at runtime by comparing that host to the page origin; we don't store which. RELATIVE → a host-less relative /c/<hash>, resolved same-origin against whatever domain the page runs on. First-party without pinning a host — the natural fit for an org tracker embedded across N domains. collector_endpoint is unused (must be empty).

Default"default"

Value in

"default"
"custom"
"relative"

collector_endpoint?string|null

source_version?Source Version

Lengthlength <= 20

Default"v1"

Response-Body

`application/json`

curl -X POST "https://example.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/applications" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",  "name": "string",  "environment": "prod",  "data_retention_days": 0,  "store_stitch": true,  "count_visitors_by": "stitch",  "site_policy": "open",  "source_hash": "string",  "collector_hash": "string",  "collect_sessions": true,  "collect_fetch_xhr": true,  "session_consent": "deferred",  "collect_error_messages": true,  "collect_error_frames": true,  "collect_query_keys": true,  "collect_query_values_for": [],  "pagetype_ruleset": "",  "collector_mode": "default",  "collector_endpoint": "string",  "source_version": "string",  "is_active": true,  "site_count": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

{  "error": {    "code": "string",    "message": "string",    "request_id": "string",    "doc_url": "string",    "details": {}  }}

{  "error": {    "code": "string",    "message": "string",    "request_id": "string",    "doc_url": "string",    "details": {}  }}

{  "error": {    "code": "string",    "message": "string",    "request_id": "string",    "doc_url": "string",    "details": {}  }}

{  "detail": [    {      "loc": [        "string"      ],      "msg": "string",      "type": "string",      "input": null,      "ctx": {}    }  ]}

{  "error": {    "code": "string",    "message": "string",    "request_id": "string",    "doc_url": "string",    "details": {}  }}

Create Application

Authentifizierung

Pfad-Parameter

Request-Body

Response-Body

201application/json

401application/json

403application/json

404application/json

422application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`