Skip to main content
GET
/
projects
/
{projectId}
/
entries
/
{entryId}
/
events
cURL
curl --request GET \
  --url https://api.embeddables.com/projects/{projectId}/entries/{entryId}/events \
  --header 'X-Api-Key: <x-api-key>'
[
  {
    "entry_id": "entry_myexampleentry",
    "contact_id": "contact_myexamplecontact",
    "project_id": "pr_myexampleproject",
    "group_id": "group_myexamplegroup",
    "embeddable_id": "flow_myexampleflow",
    "embeddable_version_number": 1,
    "timestamp": "2022-01-01T00:00:00Z",
    "page_id": "page_myexamplepageid1",
    "page_key": "page_myexamplepagekey1",
    "page_index": 1,
    "max_page_id": "page_myexamplemaxpageid2",
    "max_page_key": "page_myexamplemaxpagekey2",
    "max_page_index": 2,
    "total_pages": 3,
    "event_type": "flowpage.viewed",
    "view_type": "flowpage",
    "custom_event_name": "my_custom_event",
    "custom_event_props": "{ \"key\": \"value\" }"
  },
  {
    "entry_id": "entry_myexampleentry",
    "contact_id": "contact_myexamplecontact",
    "project_id": "pr_myexampleproject",
    "group_id": "group_myexamplegroup",
    "embeddable_id": "flow_myexampleflow",
    "embeddable_version_number": 1,
    "timestamp": "2022-01-01T00:01:00Z",
    "page_id": "page_myexamplepageid2",
    "page_key": "page_myexamplepagekey2",
    "page_index": 2,
    "max_page_id": "page_myexamplemaxpageid2",
    "max_page_key": "page_myexamplemaxpagekey2",
    "max_page_index": 2,
    "total_pages": 3,
    "event_type": "flowpage.viewed",
    "view_type": "flowpage",
    "custom_event_name": "my_custom_event",
    "custom_event_props": "{ \"key\": \"value\" }"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.embeddables.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
X-Api-Key
string
required

Path Parameters

​
projectId
string
required

The unique identifier for a Project in the database

​
entryId
string
required

The unique identifier for an Entry in the database

Query Parameters

​
limit
integer | null

The number of entries to return (defaults to 10).

​
direction
enum<string> | null

The direction to sort by (defaults to DESC)

Available options:
ASC,
DESC

Response

​
entry_id
string
required

The unique identifier for an Entry in the database

​
contact_id
string
required

The unique identifier for a Contact in the database

​
project_id
string
required

The unique identifier for a Project in the database

​
group_id
string
required

The unique identifier for a Group in the database

​
embeddable_id
string
required

The unique identifier for a Embeddable in the database

​
timestamp
string
required

A Date + Time string in ISO format

​
event_type
string
required
​
embeddable_version_number
integer | null

The version number of an embeddable

​
page_id
string | null
​
page_key
string | null
​
page_index
integer | null
​
max_page_id
string | null
​
max_page_key
string | null
​
max_page_index
integer | null
​
total_pages
integer | null
​
view_type
string | null
​
custom_event_name
string | null
​
custom_event_props
string | null