Edgee documentation

Components

API Reference

Open Source

Console

Support

The domain object is used to represent a domain in Edgee.

The Domain object

<string>

A Domain is a hostname that you can use to access your project. Each domain belongs to a project.

An open source platform offering a set of edge computing services.

Welcome to Edgee

Scalable and available anywhere, in milliseconds

Architecture

Edgee is powered by a global network of interconnected nodes that communicate with each other to relay transactions and information.

Network Map

Learn how we estimate data loss on your website in minutes

Data Loss Estimation

Discover answers to your most pressing questions about Edgee.

Quickstart

Project Settings

How to configure custom routing rules for your Edgee project

Routing rules

How to configure custom domains for your Edgee project

Custom domains

How to configure caching for your Edgee project

Caching

How to filter cookies for your Edgee project

Cookies

Project statistics

Learn how to integrate the Edgee SDK to interact with Edgee services.

Choose your SDK

Integrate the JavaScript SDK in a web application.

JS SDK

ReactJS SDK

Integrate Edgee with a mobile application.

Mobile SDK

Migration guide

How to view and inspect a live stream of events from your website

Debugging

Services Overview

Edgee services overview

Privacy-friendly data collection, at the edge.

Data Collection Highlights

Data Layer configuration

Page event

Track event

User event

Learn more about Edgee's Privacy and Data Anonymization

Privacy

Move your analytics to the edge and finally get 100% of the data to take better decisions.

Data Collection Catalog

A/B Testing at the edge, the way it should be

A/B Testing Highlights

Move your A/B Testing providers to the edge and finally get rid of the flicker, and serve 100% of your users with the best performing variant.

A/B Testing Catalog

Edge is the new frontier for security, let us bring the top security solutions to you

Security Highlights

Secure your website or application with powerful access control mechanisms

Access control

How to redirect all HTTP traffic to HTTPS

HTTPS enforcement

Finally, integrate your security solutions at the edge effortlessly

Security Catalog

Explore the Edgee components with leading technologies.

Overview

Components Overview

Google Analytics is the leading analytics platform by Google, **now at the edge**.

Google Analytics

Build better products by turning your user data into meaningful insights, using Amplitude's digital analytics platform, **now at the edge**.

Amplitude

Master and share a complete data-driven view of your customer with Piano Analytics, **now at the edge**.

Piano Analytics

Segment is a customer data platform (CDP) that helps you collect, clean, and activate your customer data, **now at the edge**.

Segment

Statsig is a modern feature management and experimentation platform, **now at the edge**.

Statsig

Bot & online fraud protection powered by multi-layered machine learning - now at the edge.

Datadome

Curated Threat Intelligence Powered by the Crowd - now at the edge

Crowdsec

Introduction

Authentication

How Edgee API responds when errors occur.

Errors

ApiToken endpoints allow you to create, list, get and delete ApiTokens.

ApiToken endpoints

The ApiToken object is used to represent an API token in Edgee.

The ApiToken object

Creates a new ApiToken. The ApiToken is returned, including its `token` field, which you should record for future reference. **Be careful, this token is only returned once, when the token is created.**

Create an ApiToken

Retrieve an ApiToken that has previously been created.

Retrieve an ApiToken

Delete an ApiToken that has previously been created. Once deleted, the ApiToken can no longer be used to authenticate requests.

Delete an ApiToken

Returns a list of your ApiTokens. The ApiTokens are returned sorted by creation date, with the most recent ApiTokens appearing first.

List all ApiTokens

Organization endpoints allow you to create, list, get and delete Organizations.

Organization endpoints

The Organization object is used to represent an Organization in Edgee.

The Organization object

Create an Organization

Update an Organizations

Retrieve an Organization that has previously been created.

Retrieve an Organization

Retrieve my Organization personal organization.

Retrieve my Organization

Delete an Organization

Returns a list of your Organizations. The Organizations are returned sorted by creation date, with the most recent Organizations appearing first.

List all Organizations

Retrieves all the Users of an organizations.

List Organization users

Remove an existing User from an Organization.

Remove a User from an Organization

Updates an existing User of an Organization.

Update Organization user

Project endpoints allow you to create, list, get and delete Projects.

Project endpoints

The project object is used to represent a project in Edgee.

The Project object

Create a Project

Update a Project

Retrieve a Project that has previously been created.

Retrieve a Project

Delete an Project

Returns a list of your Projects. The Projects are returned sorted by creation date, with the most recent Project appearing first.

List all Projects

Domain endpoints allow you to create, list, get and delete Domains for a project.

Domain endpoints

Create a Domain

Update a Domain

Retrieve a Domain that has previously been created.

Retrieve a Domain

Delete an Domain

List all Domains

ProxySettings endpoints allow you to list, create and update the proxy settings of a Project.

ProxySettings endpoints

The ProxySettings object represents a revision of a Proxy Settings.

The ProxySetting object

Create a ProxySettings

Update a ProxySettings

Retrieves all the Proxy Settings revisions of a project.

List all ProxySettings

Component endpoints allow you to list and get all the Edgee components.

Component endpoints

The component object is used to represent a component in Edgee.

The Component object

Retrieve a Component

List all Components

ProjectComponent endpoints allow you to create, list, get and delete Component for a project.

ProjectComponent endpoints

The ProjectComponent object is used to represent an integration of a component of a project.

The ProjectComponent object

Create a ProjectComponent

Update a ProjectComponent

Retrieve a Project Component that has previously been set up.

Retrieve a ProjectComponent

Delete an ProjectComponent

Retrieves all the Components of a project.

List all ProjectComponents

Endpoints

The IncomingDataCollectionEvent object represents an incoming data collection event.

The Incoming Event object

Retrieves all the Incoming Data Collection Events of a project.

List Incoming Events

The OutgoingDataCollectionEvent object represents an outgoing data collection event.

The Outgoing Event object

Retrieves all the Outgoing Data Collection Events of a project.

List Outgoing Events

User endpoints allow you to get and list Users.

User endpoints

The User object is used to represent a user in Edgee.

The User object

Retrieve a User that has previously been created.

Retrieve a User

Endpoints for managing invitations to organizations.

Invitation endpoints

The invitation object is used to represent an invitation in Edgee.

The Invitation object

Create an Invitation

Retrieve an Invitation that has previously been created.

Retrieve an Invitation

Delete an Invitation

Returns a list of the invitation of your organizations. The Invitations are returned sorted by creation date, with the most recent Invitation appearing first.

List all Invitations

A brief introduction to your project's Data Collection API.

Collects a new Edgee event at the edge and forwards it to the configured components.

Collect an Edgee event

Check out Edgee's open source projects and components

API Documentation