# Code auto-generated. DO NOT EDIT.

openapi: 3.0.0

info:

title: Faro API

description: The Faro API accepts payloads from the Faro SDKs.

version: 1.0.0

license:

name: MIT

url: https://opensource.org/licenses/MIT

servers:

- url: /collect/{appKey}

description: Faro Collector API

variables:

appKey:

default: default

description: The application key is provided by your endpoint provider.

paths:

/collect/{appKey}:

post:

operationId: submitPayload

security: []

parameters:

- name: appKey

description: 'The application key is provided by your endpoint provider.

'

in: path

required: true

schema:

type: string

requestBody:

description: Optional description in *Markdown*

required: true

content:

application/json:

schema:

$ref: '#/components/schemas/Payload'

summary: Submit a Faro payload

responses:

default:

description: OK

'202':

description: OK

'400':

description: Bad Request

content:

application/json:

schema:

$ref: '#/components/schemas/Exception'

'500':

description: Internal Server Error

content:

application/json:

schema:

$ref: '#/components/schemas/Exception'

components:

schemas:

Action:

type: object

description: holds data about user action events. These are events that are

directly related to user interactions as well as the parent action itself

properties:

name:

type: string

description: Action name (e.g. `click`, `submit`)

x-go-type-skip-optional-pointer: true

id:

type: string

description: Unique action identifier

x-go-type-skip-optional-pointer: true

parentId:

type: string

description: Parent action ID for nested actions

x-go-type-skip-optional-pointer: true

x-go-type-skip-optional-pointer: true

App:

type: object

description: holds metadata about the application event originates from.

properties:

bundleId:

type: string

description: 'Bundle identifier (used by web apps bundled with Faro bundler

plugins and mobile Android symbolication to encode build identity "{applicationId}@{versionCode}@{versionName}"

(e.g. com.example.app@[email protected]) matching the symbols upload path and server-side

R8/native retrace lookup key).

'

x-go-type-skip-optional-pointer: true

gitHash:

type: string

description: Git hash of the application source code this telemetry was

generated from

x-go-type-skip-optional-pointer: true

environment:

type: string

description: Deployment environment (e.g. `production`, `staging`)

x-go-type-skip-optional-pointer: true

installationId:

type: string

description: 'Per-installation identifier (OTel: app.installation.id). Identical

across launches of the same installed app; resets on uninstall/reinstall.

Privacy-preserving alternative to device.id. On iOS, typically sourced

from identifierForVendor.

'

x-go-type-skip-optional-pointer: true

name:

type: string

description: Application name

x-go-type-skip-optional-pointer: true

namespace:

type: string

description: Application namespace

x-go-type-skip-optional-pointer: true

release:

type: string

description: Release identifier

x-go-type-skip-optional-pointer: true

version:

type: string

description: Application version

x-go-type-skip-optional-pointer: true

x-go-type-skip-optional-pointer: true

Brand:

type: object

description: represents a single browser brand.

properties:

brand:

type: string

description: Brand name

x-go-type-skip-optional-pointer: true

version:

type: string

description: Brand version

x-go-type-skip-optional-pointer: true

x-go-type-skip-optional-pointer: true

BrandsArray:

type: array

items:

$ref: '#/components/schemas/Brand'

BrandsString:

type: string

description: represents brands as a string.

x-go-type-skip-optional-pointer: true

Browser:

type: object

description: holds metadata about a client's browser.

properties:

name:

type: string

description: Browser name (e.g. `Chrome`)

x-go-type-skip-optional-pointer: true

version:

type: string

description: Browser version

x-go-type-skip-optional-pointer: true

os:

type: string

description: Operating system

x-go-type-skip-optional-pointer: true

x-go-name: OS

mobile:

type: boolean

description: Whether the browser is on a mobile device

x-go-type-skip-optional-pointer: true

userAgent:

type: string

description: Full user agent string

x-go-type-skip-optional-pointer: true

language:

type: string

description: Browser language

x-go-type-skip-optional-pointer: true

brands:

description: Browser brand list; either a string or an array of Brand objects

oneOf:

- $ref: '#/components/schemas/BrandsString'

- $ref: '#/components/schemas/BrandsArray'

x-go-type-skip-optional-pointer: true

viewportWidth:

type: string

description: Viewport width in pixels

x-go-type-skip-optional-pointer: true

viewportHeight:

type: string

description: Viewport height in pixels

x-go-type-skip-optional-pointer: true

x-go-type-skip-optional-pointer: true

Device:

type: object

description: holds metadata about the device the app runs on.

properties:

manufacturer:

type: string

description: 'Device manufacturer (OTel: device.manufacturer). E.g. Apple,

Samsung.'

x-go-type-skip-optional-pointer: true

model_identifier:

type: string

description: 'Machine-readable model ID (OTel: device.model.identifier).

E.g. iPhone3,4, SM-G920F.'

x-go-type-skip-optional-pointer: true

model_name:

type: string

description: 'Human-readable model name (OTel: device.model.name). E.g.

iPhone 6s Plus.'

x-go-type-skip-optional-pointer: true

brand:

type: string

description: Consumer-facing brand. E.g. Google Pixel, Samsung Galaxy.

x-go-type-skip-optional-pointer: true

is_physical:

type: boolean

description: Whether this is a physical device (true) or emulator/simulator

(false).

x-go-type-skip-optional-pointer: true

type:

type: string

description: Device form factor. E.g. mobile, tablet.

x-go-type-skip-optional-pointer: true

x-go-type-skip-optional-pointer: true

Event:

type: object

description: holds RUM event data.

required:

- name

properties:

attributes:

type: object

description: Arbitrary event attributes

additionalProperties:

type: string

x-go-type-skip-optional-pointer: true

domain:

type: string

description: Event domain / category

x-go-type-skip-optional-pointer: true

name:

type: string

description: Event name

timestamp:

type: string

description: Time the event occurred

format: date-time

x-go-type-skip-optional-pointer: true

trace:

description: Associated trace and span IDs

$ref: '#/components/schemas/TraceContext'

action:

description: Associated user action

$ref: '#/components/schemas/Action'

x-go-type-skip-optional-pointer: true

Exception:

description: holds all the data regarding an exception.

type: object

required:

- timestamp

properties:

context:

description: Arbitrary key-value context

$ref: '#/components/schemas/ExceptionContext'

x-go-type-skip-optional-pointer: true

stacktrace:

description: Stack trace

$ref: '#/components/schemas/Stacktrace'

timestamp:

type: string

description: Time the exception was captured

format: date-time

trace:

description: Associated trace and span IDs

$ref: '#/components/schemas/TraceContext'

x-go-type-skip-optional-pointer: true

type:

type: string

description: Exception class or type name

x-go-type-skip-optional-pointer: true

fatal:

type: boolean

description: 'Whether this exception caused app termination (crash, ANR,

OOM). Defaults to false when not set. Web exceptions are typically non-fatal;

mobile SDKs set this for native crash reports.

'

x-go-type-skip-optional-pointer: true

fingerprint:

type: string

description: Custom grouping fingerprint

x-go-type-skip-optional-pointer: true

value:

type: string

description: Exception message

x-go-type-skip-optional-pointer: true

action:

description: Associated user action

$ref: '#/components/schemas/Action'

x-go-type-skip-optional-pointer: true

ExceptionContext:

type: object

additionalProperties:

type: string

x-go-type-skip-optional-pointer: true

Frame:

type: object

description: represents a single stacktrace frame.

properties:

colno:

type: integer

description: Column number

x-go-type-skip-optional-pointer: true

filename:

type: string

description: Source file name or URL

x-go-type-skip-optional-pointer: true

function:

type: string

description: Function name

x-go-type-skip-optional-pointer: true

lineno:

type: integer

description: Line number

x-go-type-skip-optional-pointer: true

module:

type: string

description: Module name

x-go-type-skip-optional-pointer: true

x-go-type-skip-optional-pointer: true

Geo:

type: object

description: holds metadata about a client's geo.

properties:

continent_iso:

type: string

description: Continent ISO code

x-go-type-skip-optional-pointer: true

x-go-name: ContinentISOCode

country_iso:

type: string

description: Country ISO 3166-1 alpha-2 code

x-go-type-skip-optional-pointer: true

x-go-name: CountryISOCode

subdivision_iso:

type: string

description: Subdivision / state ISO code

x-go-type-skip-optional-pointer: true

x-go-name: SubdivisionISO

city:

type: string

description: City name

x-go-type-skip-optional-pointer: true

asn_org:

type: string

description: ASN organisation name

x-go-type-skip-optional-pointer: true

x-go-name: ASNOrg

asn_id:

type: string

description: ASN identifier

x-go-type-skip-optional-pointer: true

x-go-name: ASNID

x-go-type-skip-optional-pointer: true

K6:

type: object

description: holds metadata about whether or not the run happened in a K6 browser.

properties:

isK6Browser:

type: boolean

description: '`true` when running inside a k6 browser session'

x-go-type-skip-optional-pointer: true

testRunId:

type: string

description: k6 test run identifier when running inside a k6 browser session

x-go-type-skip-optional-pointer: true

x-go-name: TestRunID

x-go-type-skip-optional-pointer: true

Kind:

type: string

enum:

- event

- exception

- log

- measurement

- unknown

Log:

type: object

description: controls the data that come into a Log message.

required:

- timestamp

properties:

context:

description: Arbitrary key-value context

$ref: '#/components/schemas/LogContext'

x-go-type-skip-optional-pointer: true

level:

description: Log severity level

$ref: '#/components/schemas/LogLevel'

x-go-type-skip-optional-pointer: true

x-go-name: LogLevel

message:

type: string

description: Log message text

x-go-type-skip-optional-pointer: true

timestamp:

type: string

description: Time the log was captured

format: date-time

trace:

description: Associated trace and span IDs

$ref: '#/components/schemas/TraceContext'

action:

description: Associated user action

$ref: '#/components/schemas/Action'

x-go-type-skip-optional-pointer: true

LogContext:

type: object

description: is a string to string map structure that represents the context

of a log message.

additionalProperties:

type: string

x-go-type-skip-optional-pointer: true

LogLevel:

type: string

description: log level enum for incoming app logs.

enum:

- trace

- debug

- info

- warning

- error

x-go-type-skip-optional-pointer: true

x-go-name: LogLevel

Measurement:

type: object

description: holds the data for user provided measurements.

properties:

context:

description: Arbitrary key-value context

$ref: '#/components/schemas/MeasurementContext'

timestamp:

type: string

description: Time the measurement was captured

format: date-time

x-go-type-skip-optional-pointer: true

trace:

description: Associated trace and span IDs

$ref: '#/components/schemas/TraceContext'

type:

type: string

description: Measurement type name

x-go-type-skip-optional-pointer: true

values:

type: object

description: Named numeric values

additionalProperties:

type: number

format: double

x-go-type-skip-optional-pointer: true

action:

description: Associated user action

$ref: '#/components/schemas/Action'

x-go-type-skip-optional-pointer: true

MeasurementContext:

type: object

additionalProperties:

type: string

x-go-type-skip-optional-pointer: true

Meta:

type: object

description: holds metadata about an app event.

properties:

sdk:

description: Metadata about the Faro SDK that produced the payload

$ref: '#/components/schemas/SDK'

app:

description: Metadata about the application

$ref: '#/components/schemas/App'

user:

description: Metadata about the end user

$ref: '#/components/schemas/User'

session:

description: Metadata about the browser/app session

$ref: '#/components/schemas/Session'

page:

description: Metadata about the current web page

$ref: '#/components/schemas/Page'

browser:

description: Metadata about the browser

$ref: '#/components/schemas/Browser'

device:

description: Metadata about the device

$ref: '#/components/schemas/Device'

os:

description: Metadata about the operating system

x-go-name: OS

allOf:

- $ref: '#/components/schemas/OS'

k6:

description: Metadata indicating whether the session runs in k6 browser

$ref: '#/components/schemas/K6'

view:

description: Metadata about the current view/screen

$ref: '#/components/schemas/View'

geo:

description: Geo information (populated server-side by the receiver)

$ref: '#/components/schemas/Geo'

x-go-type-skip-optional-pointer: true

OS:

type: object

description: holds metadata about the operating system the app runs on.

properties:

name:

type: string

description: 'OS name (OTel: os.name). E.g. iOS, Android, Windows, macOS.'

x-go-type-skip-optional-pointer: true

version:

type: string

description: 'OS version string (OTel: os.version). E.g. 18.1, 15.'

x-go-type-skip-optional-pointer: true

build_id:

type: string

description: 'OS build identifier (OTel: os.build_id). E.g. 22G91, TQ3A.230901.001.'

x-go-type-skip-optional-pointer: true

detail:

type: string

description: 'Human-readable OS version detail (OTel: os.description). Richer

than name+version alone.'

x-go-type-skip-optional-pointer: true

x-go-type-skip-optional-pointer: true

Overrides:

type: object

description: represents session override metadata.

properties:

serviceName:

type: string

description: Override the service name for this session

x-go-type-skip-optional-pointer: true

geoLocationTrackingEnabled:

type: boolean

description: Whether geo-location tracking is enabled for this session

x-go-type-skip-optional-pointer: false

x-go-type-skip-optional-pointer: true

Page:

type: object

description: holds metadata about the web page event originates from.

properties:

attributes:

type: object

description: Arbitrary page attributes

additionalProperties:

type: string

x-go-type-skip-optional-pointer: true

id:

type: string

description: Page identifier

x-go-type-skip-optional-pointer: true

url:

type: string

description: Full page URL

x-go-type-skip-optional-pointer: true

x-go-type-skip-optional-pointer: true

Payload:

type: object

description: is the body of the receiver request.

properties:

events:

type: array

description: Custom RUM events

items:

$ref: '#/components/schemas/Event'

minItems: 0

x-go-type-skip-optional-pointer: true

exceptions:

type: array

description: Captured exceptions / errors

items:

$ref: '#/components/schemas/Exception'

minItems: 0

x-go-type-skip-optional-pointer: true

logs:

type: array

description: Log messages

items:

$ref: '#/components/schemas/Log'

minItems: 0

x-go-type-skip-optional-pointer: true

measurements:

type: array

description: Custom numeric measurements

items:

$ref: '#/components/schemas/Measurement'

x-go-type-skip-optional-pointer: true

meta:

description: Contextual metadata about the app, session, user, and client

$ref: '#/components/schemas/Meta'

free-form: true

x-go-type-skip-optional-pointer: true

traces:

type: object

description: OTel trace data (OTLP JSON format)

$ref: '#/components/schemas/Traces'

SDK:

type: object

description: holds metadata about the app agent that produced the event.

properties:

name:

type: string

description: SDK name (e.g. `@grafana/faro-web-sdk`)

x-go-type-skip-optional-pointer: true

version:

type: string

description: SDK version

x-go-type-skip-optional-pointer: true

integrations:

type: array

description: Active SDK integrations/plugins

items:

$ref: '#/components/schemas/SDKIntegration'

x-go-type-skip-optional-pointer: true

x-go-type-skip-optional-pointer: true

x-go-name: SDK

SDKIntegration:

type: object

description: holds metadata about a plugin/integration on the app agent that

collected and sent the event.

properties:

name:

type: string

description: Integration name

x-go-type-skip-optional-pointer: true

version:

type: string

description: Integration version

x-go-type-skip-optional-pointer: true

Session:

type: object

description: holds metadata about the browser session the event originates from.

properties:

id:

type: string

description: Session identifier. Must match `^[a-zA-Z0-9_.@:-]+$` and be

at most 128 characters long.

x-go-type-skip-optional-pointer: true

attributes:

type: object

description: Arbitrary session attributes

additionalProperties:

type: string

x-go-type-skip-optional-pointer: true

overrides:

description: Session-level overrides

$ref: '#/components/schemas/Overrides'

x-go-type-skip-optional-pointer: true

SpanEvent:

type: object

required:

- name

properties:

attributes:

type: array

droppedAttributesCount:

type: integer

name:

type: string

timeUnixNano:

type: string

Stacktrace:

type: object

description: is a collection of Frames.

properties:

frames:

type: array

description: Ordered list of stack frames (innermost first)

items:

$ref: '#/components/schemas/Frame'

minItems: 0

x-go-type-skip-optional-pointer: true

TimeFormat:

type: string

enum:

- '2006-01-02T15:04:05.999Z'

x-enum-varnames:

- RFC3339Milli

TraceContext:

description: holds trace id and span id associated to an entity (log, exception,

measurement...).

type: object

required:

- trace_id

- span_id

properties:

span_id:

type: string

description: OTel span ID (hex-encoded)

x-go-type-skip-optional-pointer: true

x-omitempty: false

trace_id:

type: string

description: OTel trace ID (hex-encoded)

x-go-type-skip-optional-pointer: true

x-omitempty: false

x-go-type-skip-optional-pointer: true

Traces:

type: object

description: otel traces model.

x-go-type: ptrace.Traces

x-go-type-import:

name: ptrace

path: go.opentelemetry.io/collector/pdata/ptrace

User:

type: object

description: holds metadata about the user related to an app event.

properties:

username:

type: string

description: Username

x-go-type-skip-optional-pointer: true

id:

type: string

description: User identifier

x-go-type-skip-optional-pointer: true

email:

type: string

description: Email address

x-go-type-skip-optional-pointer: true

attributes:

type: object

description: Arbitrary user attributes

additionalProperties:

type: string

x-go-type-skip-optional-pointer: true

x-go-type-skip-optional-pointer: true

View:

type: object

description: holds metadata about a view.

properties:

name:

type: string

description: View or screen name

x-go-type-skip-optional-pointer: true

x-go-type-skip-optional-pointer: true