API Documentation
- Introduction
- Authentication
- Errors
- ApiTokens
- Organizations
- Projects
- Domains
- ProxySettings
- Components
- ProjectComponents
- Statistics
- DataCollectionEvents
- Users
- Invitations
- DataCollection (Project)
DataCollection (Project)
Collect an Edgee event
Collects a new Edgee event at the edge and forwards it to the configured components.
POST
/
_edgee
/
event
curl --request POST \
--url https://{project_id}.edgee.app/_edgee/event \
--header 'Content-Type: application/json' \
--data '{
"data_collection": {
"events": [
{
"type": "page",
"data": {
"name": "Page name",
"category": "category 1",
"title": "Page title",
"url": "https://demo.edgee.app/analytics-with-edgee.html",
"path": "/analytics-with-edgee.html",
"search": "?test=1",
"referrer": "https://demo.edgee.app/previous-page.html",
"keywords": [
"keyword1",
"keyword2"
],
"properties": {
"key": "value"
}
}
}
],
"context": {
"client": {
"timezone": "Europe/Paris",
"screen_width": 1512,
"screen_height": 982,
"screen_density": 2,
"user_agent_architecture": "arm",
"user_agent_bitness": "64",
"os_version": "15.1.1",
"user_agent_full_version_list": "Google Chrome;131.0.6778.109|Chromium;131.0.6778.109|Not_A Brand;24.0.0.0"
},
"campaign": {
"name": "<string>",
"source": "<string>",
"medium": "<string>",
"term": "<string>",
"content": "<string>",
"creative_format": "<string>",
"marketing_tactic": "<string>"
},
"page": {
"name": "Page name",
"category": "category 1",
"title": "Page title",
"url": "https://demo.edgee.app/analytics-with-edgee.html",
"path": "/analytics-with-edgee.html",
"search": "?test=1",
"referrer": "https://demo.edgee.app/previous-page.html",
"keywords": [
"keyword1",
"keyword2"
],
"properties": {
"key": "value"
}
},
"user": {
"user_id": "abc123",
"anonymous_id": "def345",
"properties": {
"key1": "value1",
"key2": "value2"
}
}
}
}
}'
This response does not have an example.
Body
application/json
This is a wrapper for the Edgee event object.
Response
204
No response
Was this page helpful?
curl --request POST \
--url https://{project_id}.edgee.app/_edgee/event \
--header 'Content-Type: application/json' \
--data '{
"data_collection": {
"events": [
{
"type": "page",
"data": {
"name": "Page name",
"category": "category 1",
"title": "Page title",
"url": "https://demo.edgee.app/analytics-with-edgee.html",
"path": "/analytics-with-edgee.html",
"search": "?test=1",
"referrer": "https://demo.edgee.app/previous-page.html",
"keywords": [
"keyword1",
"keyword2"
],
"properties": {
"key": "value"
}
}
}
],
"context": {
"client": {
"timezone": "Europe/Paris",
"screen_width": 1512,
"screen_height": 982,
"screen_density": 2,
"user_agent_architecture": "arm",
"user_agent_bitness": "64",
"os_version": "15.1.1",
"user_agent_full_version_list": "Google Chrome;131.0.6778.109|Chromium;131.0.6778.109|Not_A Brand;24.0.0.0"
},
"campaign": {
"name": "<string>",
"source": "<string>",
"medium": "<string>",
"term": "<string>",
"content": "<string>",
"creative_format": "<string>",
"marketing_tactic": "<string>"
},
"page": {
"name": "Page name",
"category": "category 1",
"title": "Page title",
"url": "https://demo.edgee.app/analytics-with-edgee.html",
"path": "/analytics-with-edgee.html",
"search": "?test=1",
"referrer": "https://demo.edgee.app/previous-page.html",
"keywords": [
"keyword1",
"keyword2"
],
"properties": {
"key": "value"
}
},
"user": {
"user_id": "abc123",
"anonymous_id": "def345",
"properties": {
"key1": "value1",
"key2": "value2"
}
}
}
}
}'
This response does not have an example.