SDKs
Astro
Installation
Install dependencies
Initialize
Add OpenPanelComponent
to your root layout component.
Options
Common options
apiUrl
- The url of the openpanel API or your self-hosted instanceclientId
- The client id of your applicationclientSecret
- The client secret of your application (only required for server-side events)filter
- A function that will be called before sending an event. If it returns false, the event will not be sentdisabled
- If true, the library will not send any events
Web options
trackScreenViews
- If true, the library will automatically track screen views (default: false)trackOutgoingLinks
- If true, the library will automatically track outgoing links (default: false)trackAttributes
- If true, you can trigger events by using html attributes (<button type="button" data-track="your_event" />
) (default: false)
Astro options
profileId
- If you have a user id, you can pass it here to identify the usercdnUrl
- The url to the OpenPanel SDK (default:https://openpanel.dev/op1.js
)filter
- This is a function that will be called before tracking an event. If it returns false the event will not be tracked. Read moreglobalProperties
- This is an object of properties that will be sent with every event.
filter
This options needs to be a stringified function and cannot access any variables outside of the function.
To take advantage of typescript you can do the following. Note toString
Usage
Client-side Tracking
You can track events with the global op function or you can use data attributes.
Identifying Users
To identify a user, you can use either the identify
function or the IdentifyComponent
.
Setting Global Properties
You can set global properties that will be sent with every event using either the setGlobalProperties
function or the SetGlobalPropertiesComponent
.