An event is a user action that you consider important (for example, making an order, registering, paying a subscription, visiting a page with tariffs, visiting a product page, etc.)
Events are divided into 2 groups: custom (you create your own event names), sysytem reserved (have system keys for names, starting with a $ character)
System key | Attributes | Purpose |
---|---|---|
$registered |
$name : User name$phone : User phone$email : User email$user_id : Your unique id for this user |
Record user registration in the personal account. For funnels, segmentation, welcome/onboarding |
Frontend (JS API)
dashly.track('$registered', {
'$name': 'Chris',
'$phone': '9876543210',
'$email': 'chris@email.io',
'$user_id': '123qwe'
});
System key | Attributes | Purpose |
---|---|---|
$authorized |
$name : User name$phone : User phone$email : User email$user_id : Your unique id for this user |
Record user authorization in the personal account. For retention analytics, "on return" triggers |
Frontend (JS API)
dashly.track('$authorised', {
'$name': 'Chris',
'$phone': '9876543210',
'$email': 'chris@email.io',
'$user_id': '123qwe'
});
System key | Attributes | Purpose |
---|---|---|
$demo_form_read |
no attributes | Record user openning and reading the demo form |
Frontend (JS API)
dashly.track('$demo_form_read');
System key | Attributes | Purpose |
---|---|---|
$demo_form_completed |
$name : User name$phone : User phone$email : User emailDemo request page : url of the page, where form was submitted |
Demo form successful submission |
Frontend (JS API)
dashly.track('$demo_form_completed', {
'$name': 'Chris',
'$phone': '9876543210',
'$email': 'chris@email.io',
'Demo request page': 'https://some.page'
});
System key | Attributes | Purpose |
---|---|---|
$quiz_visited |
no attributes | On visiting https://quiz.*./ URL |
Frontend (JS API)
dashly.track('$quiz_visited');
System key | Attributes | Purpose |
---|---|---|
$page_visited |
H1 : h1 tag contentsDescription : page title or description |
On visiting any page |
Frontend (JS API)
dashly.track('$page_visited', {
'H1': 'Some text from h1',
'Description': 'some text from title/description'
});
System key | Attributes | Purpose |
---|---|---|
$crm_contact_established |
no attributes | CRM: Contact established |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
event |
string[1;255] | Event name (up to 255 characters) |
params |
Optional[Dict] | Event properties. Default: {} |
app |
Optional[ID] | D of requesting application. Default: calculated based on access token |
Track CRM: Contact established
by user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "event=$crm_contact_established" \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
"https://api.dashly.app/users/user-7216/events"
Track CRM: Contact established
event by user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "event=$crm_contact_established" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/events
System key | Attributes | Purpose |
---|---|---|
$crm_qualified |
no attributes | CRM: Qualified |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
event |
string[1;255] | Event name (up to 255 characters) |
params |
Optional[Dict] | Event properties. Default: {} |
app |
Optional[ID] | D of requesting application. Default: calculated based on access token |
Track CRM: Qualified
by user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "event=$crm_qualified" \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
"https://api.dashly.app/users/user-7216/events"
Track CRM: Qualified
event by user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "event=$crm_qualified" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/events
System key | Attributes | Purpose |
---|---|---|
$crm_meeting_scheduled |
Host manager : Host managerDate for call : Date for callMeeting link : Meeting link |
CRM: Meeting Scheduled |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
event |
string[1;255] | Event name (up to 255 characters) |
params |
Optional[Dict] | Event properties. Default: {} |
app |
Optional[ID] | D of requesting application. Default: calculated based on access token |
Track CRM: Meeting Scheduled
by user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "event=$crm_meeting_scheduled" \
--data-urlencode 'params={"Host manager": "Host manager", "Date for call":"Date for call", "Meeting link":"Meeting link"}' \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
"https://api.dashly.app/users/user-7216/events"
Track CRM: Meeting Scheduled
event by user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "event=$crm_meeting_scheduled" \
--data-urlencode 'params={"Host manager": "Host manager", "Date for call":"Date for call", "Meeting link":"Meeting link"}' \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/events
System key | Attributes | Purpose |
---|---|---|
$crm_meeting |
Host manager : Host managerDate for call : Date for call |
CRM: Meeting conducted |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
event |
string[1;255] | Event name (up to 255 characters) |
params |
Optional[Dict] | Event properties. Default: {} |
app |
Optional[ID] | D of requesting application. Default: calculated based on access token |
Track CRM: Meeting
by user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "event=$crm_meeting" \
--data-urlencode 'params={"Host manager": "Host manager", "Date for call":"Date for call"}' \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
"https://api.dashly.app/users/user-7216/events"
Track CRM: Meeting
event by user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "event=$crm_meeting" \
--data-urlencode 'params={"Host manager": "Host manager", "Date for call":"Date for call"}' \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/events
System key | Attributes | Purpose |
---|---|---|
$crm_opportunity |
Description : DescriptionBudget : Budget |
CRM: Opportunity |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
event |
string[1;255] | Event name (up to 255 characters) |
params |
Optional[Dict] | Event properties. Default: {} |
app |
Optional[ID] | D of requesting application. Default: calculated based on access token |
Track CRM: Opportunity
by user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "event=$crm_opportunity" \
--data-urlencode 'params={"Description": "Description", "Budget":"Budget"}' \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
"https://api.dashly.app/users/user-7216/events"
Track CRM: Opportunity
event by user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "event=$crm_opportunity" \
--data-urlencode 'params={"Description": "Description", "Budget":"Budget"}' \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/events
System key | Attributes | Purpose |
---|---|---|
$crm_invoice_sent |
Budget : Budget |
CRM: Invoice sent |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
event |
string[1;255] | Event name (up to 255 characters) |
params |
Optional[Dict] | Event properties. Default: {} |
app |
Optional[ID] | D of requesting application. Default: calculated based on access token |
Track CRM: Invoice sent
by user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "event=$crm_invoice_sent" \
--data-urlencode 'params={"Budget":"Budget"}' \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
"https://api.dashly.app/users/user-7216/events"
Track CRM: Invoice sent
event by user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "event=$crm_invoice_sent" \
--data-urlencode 'params={"Budget":"Budget"}' \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/events
System key | Attributes | Purpose |
---|---|---|
$crm_paid |
Budget : Budget |
CRM: Paid |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
event |
string[1;255] | Event name (up to 255 characters) |
params |
Optional[Dict] | Event properties. Default: {} |
app |
Optional[ID] | D of requesting application. Default: calculated based on access token |
Track CRM: Paid
by user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "event=$crm_paid" \
--data-urlencode 'params={"Budget":"Budget"}' \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
"https://api.dashly.app/users/user-7216/events"
Track CRM: Paid
event by user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "event=$crm_paid" \
--data-urlencode 'params={"Budget":"Budget"}' \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/events
System key | Attributes | Purpose |
---|---|---|
$crm_lost |
Reason : Reason |
CRM: Deal lost |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
event |
string[1;255] | Event name (up to 255 characters) |
params |
Optional[Dict] | Event properties. Default: {} |
app |
Optional[ID] | D of requesting application. Default: calculated based on access token |
Track CRM: Lost
by user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "event=$crm_lost" \
--data-urlencode 'params={"Reason":"Reason"}' \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
"https://api.dashly.app/users/user-7216/events"
Track CRM: Lost
event by user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "event=$crm_lost" \
--data-urlencode 'params={"Reason":"Reason"}' \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/events
System key | Attributes | Purpose |
---|---|---|
$crm_lead_delivered |
No attributes | CRM: Lead Delivered |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
event |
string[1;255] | Event name (up to 255 characters) |
params |
Optional[Dict] | Event properties. Default: {} |
app |
Optional[ID] | D of requesting application. Default: calculated based on access token |
Track CRM: Lead Delivered
by user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "event=$crm_lead_delivered" \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
"https://api.dashly.app/users/user-7216/events"
Track CRM: Lead Delivered
event by user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "event=$crm_lead_delivered" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/events