List all events

GET 
https://api.freemius.com/v1/products/{product_id}/users/{user_id}/events.json

Auth:Bearer TokenSCOPE: PRODUCT

Product-scoped API tokens allow you to operate on the product itself. This token usually allows read-only access to the product configuration and write access to several operations on subscriptions, customers, payments, and more. For most SaaS or app integrations, this is the token you will need.

1. Go to the Freemius Developer Dashboard.
2. Open the Settings page of the relevant product.
3. Click the API & Keys tab.
4. Copy the API Bearer Authorization Token from the UI.

---

Retrieve a log of the events for the user associated with the product. Freemius tracks events such as opt-in, license activation, purchase etc. You can use this data for marketing and other automation purposes. More information can be found here.

Request

Path Parameters

product_id integer<int64>required
The ID of the product.
Possible values: >= 1
Example: 1234
user_id integer<int64>required
The ID of the User.
Possible values: >= 1
Example: 1234

Query Parameters

fields string
Comma separated list of fields to return in the response. If not specified, all fields are returned.
Example: id,name,slug
count integer
Default value: 25
The number of records to return.
Possible values: >= 1 and <= 50
Example: 10
offset integer
Default value: 0
The number of records to skip before starting to return records. Default is 0.
Possible values: >= 0
Example: 10

Responses

200

The user's events log.

application/json

Schema

events object[]

Array [

statestring

State of the event log. It essentially says whether the event was processed through the webhook or not.

Possible values: [processed, pending, canceled, error]

idstring<int64>

The unique identifier of the entity.

Possible values: >= 1

Example: 123456

createdstring<date-time>

The date and time the entity was created, under UTC timezone.

Example: 2025-01-01 00:00:00

updatedstring<date-time>nullable

The date and time the entity was updated, under UTC timezone. If null then the entity was never updated since its creation.

Example: 2025-01-01 00:00:00

typestring

The type of event. See our documented list of the available event types.

Example: license.activated

developer_idstring<int64>

The ID of the developer.

Possible values: >= 1

Example: 1234

plugin_idstring<int64>nullable

The ID of the product the entity belongs to. Null means it has not been associated with a product yet.

Possible values: >= 1

Example: 123456

user_idstring<int64>nullable

The ID of the user the entity belongs to. If NULL then still not associated to any user.

Possible values: >= 1

Example: 123456

install_idstring<int64>nullable

The ID of the installation or site the entity is associated with, a null value means it has not been associated with an installation yet.

Possible values: >= 1

Example: 123456

datanullable

The details of the triggered event. This can be a string showing ID of the associated entity, an object with additional information of the event, or array of objects.

event_triggerstring

The type of trigger for the event.

Possible values: [system, developer, plugin, user, install]

Example: system

process_timestring<date-time>nullable

The time the event was processed. If it is null, the event is pending.

Example: 2025-01-01 12:00:00

]