Collect an Edgee event - Edgee documentation

Collect a new 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"
        }
      }
    }
  }
}
'

{
  "error": {
    "type": "invalid_request_error",
    "message": "Parameter error.",
    "params": [
      {
        "param": "name",
        "message": "Name is required."
      }
    ]
  }
}

POST

_edgee

event

Collect a new 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"
        }
      }
    }
  }
}
'

{
  "error": {
    "type": "invalid_request_error",
    "message": "Parameter error.",
    "params": [
      {
        "param": "name",
        "message": "Name is required."
      }
    ]
  }
}

Body

application/json

This is a wrapper for the Edgee event object.

data_collection

object

required

The data collection object includes details about context and events.

Show child attributes

data_collection.events

object[]

required

The events array includes a list of events to collect at the edge.

This is a wrapper for the Edgee page event.

Option 1
Option 2
Option 3

Show child attributes

data_collection.events.type

enum<string>

default:page

required

The page event type

Available options:

page

data_collection.events.data

object

required

The page event's data. This will be merged with the data_collection.context.page object.

Show child attributes

data_collection.events.data.name

string

The page's name/title.

Example:

"Page name"

data_collection.events.data.category

string

The page's category.

Example:

"category 1"

data_collection.events.data.title

string

The page's title.

Example:

"Page title"

data_collection.events.data.url

string

The page's full URL.

Example:

"https://demo.edgee.app/analytics-with-edgee.html"

data_collection.events.data.path

string

The page's path (excluding protocol and hostname).

Example:

"/analytics-with-edgee.html"

data_collection.events.data.search

string

The page's query string.

Example:

"?test=1"

data_collection.events.data.referrer

string

The page's referrer.

Example:

"https://demo.edgee.app/previous-page.html"

data_collection.events.data.keywords

string[]

The page's meta keywords.

Example:

["keyword1", "keyword2"]

data_collection.events.data.properties

object

The page's custom properties as (string-string) key-value pairs.

Show child attributes

data_collection.events.data.properties.{key}

string

Example:

{ "key": "value" }

Example:

{
  "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" }
}

data_collection.context

object

The context object includes details about client, campaign, page, and user.

Show child attributes

data_collection.context.client

object

The context.client object includes details about the client device such as screen_width, screen_height, screen_density, and so on.

Show child attributes

data_collection.context.client.timezone

string

The client's timezone

Example:

"Europe/Paris"

data_collection.context.client.screen_width

number

The client's screen width in pixels

Example:

1512

data_collection.context.client.screen_height

number

The client's screen width in pixels

Example:

982

data_collection.context.client.screen_density

number

The client's screen width in pixels

Example:

2

data_collection.context.client.user_agent_architecture

string

The client's architecture

Example:

"arm"

data_collection.context.client.user_agent_bitness

string

The client's bitness

Example:

"64"

data_collection.context.client.user_agent_model

string

The client's user agent model

data_collection.context.client.os_version

string

The client's operating system version

Example:

"15.1.1"

data_collection.context.client.user_agent_full_version_list

string

The client's user agent full version list

Example:

"Google Chrome;131.0.6778.109|Chromium;131.0.6778.109|Not_A Brand;24.0.0.0"

Example:

{
  "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"
}

data_collection.context.campaign

object

The context.campaign object includes details about the utm data parameters.

Show child attributes

data_collection.context.campaign.name

string

The campaign name

data_collection.context.campaign.source

string

The campaign source

data_collection.context.campaign.medium

string

The campaign medium

data_collection.context.campaign.term

string

The campaign term

data_collection.context.campaign.content

string

The campaign content

data_collection.context.campaign.creative_format

string

The campaign creative format

data_collection.context.campaign.marketing_tactic

string

The campaign marketing tactis

data_collection.context.page

object

The context.page object includes details about the page that generated this event, such as its URL, title, referrer, and so on.

Show child attributes

data_collection.context.page.name

string

The page's name/title.

Example:

"Page name"

data_collection.context.page.category

string

The page's category.

Example:

"category 1"

data_collection.context.page.title

string

The page's title.

Example:

"Page title"

data_collection.context.page.url

string

The page's full URL.

Example:

"https://demo.edgee.app/analytics-with-edgee.html"

data_collection.context.page.path

string

The page's path (excluding protocol and hostname).

Example:

"/analytics-with-edgee.html"

data_collection.context.page.search

string

The page's query string.

Example:

"?test=1"

data_collection.context.page.referrer

string

The page's referrer.

Example:

"https://demo.edgee.app/previous-page.html"

data_collection.context.page.keywords

string[]

The page's meta keywords.

Example:

["keyword1", "keyword2"]

data_collection.context.page.properties

object

The page's custom properties as (string-string) key-value pairs.

Show child attributes

data_collection.context.page.properties.{key}

string

Example:

{ "key": "value" }

Example:

{
  "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" }
}

data_collection.context.user

object

The context.user object includes details about the user that generated this event.

Show child attributes

data_collection.context.user.user_id

string

The user's ID.

Example:

"abc123"

data_collection.context.user.anonymous_id

string

The user's anonymous ID.

Example:

"def345"

data_collection.context.user.properties

object

The user's custom properties as (string-string) key-value pairs.

Show child attributes

data_collection.context.user.properties.{key}

string

Example:

{ "key1": "value1", "key2": "value2" }

Example:

{
  "user_id": "abc123",
  "anonymous_id": "def345",
  "properties": { "key1": "value1", "key2": "value2" }
}

Response

No response

Introduction

⌘I

API Documentation

Body

Response