API Documentation
- Introduction
- Authentication
- Errors
- ApiTokens
- Organizations
- Projects
- Domains
- ProxySettings
- Components
- ProjectComponents
- DataCollectionEvents
- Users
- Invitations
- DataCollection (Project)
Collect an Edgee event
Collects a new Edgee event at the edge and forwards it to the configured components.
https://{project_id}.edgee.app
Project ID assigned by Edgee at creation time
This is a wrapper for the Edgee event object.
The data collection object includes details about context and events.
The events array includes a list of events to collect at the edge.
The context object includes details about client, campaign, page, and user.
The context.client object includes details about the client device such as screen_width, screen_height, screen_density, and so on.
The client's timezone
The client's screen width in pixels
The client's screen width in pixels
The client's screen width in pixels
The client's architecture
The client's bitness
The client's user agent model
The client's user agent platform
The client's user agent full version list
The context.campaign object includes details about the utm data parameters.
The campaign name
The campaign source
The campaign medium
The campaign term
The campaign content
The campaign creative format
The campaign marketing tactis
The context.page object includes details about the page that generated this event, such as its URL, title, referrer, and so on.
The page's name/title.
The page's category.
The page's title.
The page's full URL.
The page's path (excluding protocol and hostname).
The page's query string.
The page's referrer.
The page's meta keywords.
The page's custom properties as (string-string) key-value pairs.
The context.user object includes details about the user that generated this event.
The user's ID.
The user's anonymous ID.
The user's custom properties as (string-string) key-value pairs.
Body
This is a wrapper for the Edgee event object.
The data collection object includes details about context and events.
The events array includes a list of events to collect at the edge.
The page event type
page The page event's data. This will be merged with the data_collection.context.page object.
The page's name/title.
The page's category.
The page's title.
The page's full URL.
The page's path (excluding protocol and hostname).
The page's query string.
The page's referrer.
The page's meta keywords.
The context object includes details about client, campaign, page, and user.
The context.client object includes details about the client device such as screen_width, screen_height, screen_density, and so on.
The client's timezone
The client's screen width in pixels
The client's screen width in pixels
The client's screen width in pixels
The client's architecture
The client's bitness
The client's user agent model
The client's user agent platform
The client's user agent full version list
The context.campaign object includes details about the utm data parameters.
The campaign name
The campaign source
The campaign medium
The campaign term
The campaign content
The campaign creative format
The campaign marketing tactis
The context.page object includes details about the page that generated this event, such as its URL, title, referrer, and so on.
The page's name/title.
The page's category.
The page's title.
The page's full URL.
The page's path (excluding protocol and hostname).
The page's query string.
The page's referrer.
The page's meta keywords.
The context.user object includes details about the user that generated this event.