umami API docs (v3.0.0)

URL: https://github.com/ceviixx/umami-api-docs

Documentation for Umami Analytics with daily status updates to help detect undocumented changes. Information about broken or failed API endpoints, if available, can be found in the GitHub repository.

Documentation for umami Analytics

Authentication

TBD

Login

TBD

Request Body schema: application:json

username	string TBD
password	string TBD

Responses

Request samples

Payload

Content type

application:json

{"username": "string",
"password": "string"
}

Response samples

200

Content type

application/json

{"token": "km6ceWFN5t60a4zS1wwDCA4z/xPeLvQYAp838ZpdzHja5NvrB80+ioM0TxOolOaNiZJy60Ul7x4zLoAH9ODl8ChTxukbLzP3yTgXEQeNSLWCw4QWDn5IO7iID/ZopvOkUeTgKYKFOv6WNhYdpx7AU7xsIV9wzfa9hTNLmsD1VbXy5OSCEAPznwXAbPaydofVptsOOeHmjmdqRSQMn+Nrv74+Qp7YvVIt25QQUNxvc7if81HI8WwblZ2OShjvL6dPBrnnGLl/KxyRY7LAoBZ+TzypCQckqjwWQ2YJCWjRciXBEUzod72jJz9nj1PhOISwgqSnvjxQon2nVqOowvtjo6PcrMj5scDrPa1MZPsU2n3Z+VyhNNzvJZ27vfPP",
"user": {"id": "41e2b680-648e-4b09-bcd7-3e2b10c06264",
"username": "admin",
"role": "admin",
"createdAt": "2025-10-09T08:17:51.401Z",
"isAdmin": true
}
}

Verfiy

TBD

Authorizations:

bearer-token

Responses

Response samples

200

Content type

application/json

{"id": "41e2b680-648e-4b09-bcd7-3e2b10c06264",
"username": "admin",
"role": "admin",
"createdAt": "2025-10-09T08:17:51.401Z",
"isAdmin": true
}

My account

TBD

My details

TBD

Authorizations:

api-keybearer-token

Responses

Response samples

200

Content type

application/json

{"token": "Y2xvU2VjdXJlL2Rldl9rR2JYbTZxR1l4T3ZxQ2xkQXVpU2Eyb1lhdWV2bU9YQUd2ZFk4M1JXbWoyZlFzR0JtSm1zS1ZtRWtqUUNmQm5QbU5qZ2JjQnJmOG1mUjZPc1p0Z2hDaj09",
"shareToken": null,
"user": {"id": "5f9c2d41-8b7a-4e21-92d3-1c4b7a9f2e60",
"username": "dev.user@example.com",
"role": "user",
"createdAt": "2024-04-17T19:20:55.624Z",
"isAdmin": false
}
}

My teams

TBD

Authorizations:

api-keybearer-token

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "d7a2b1c3-4e5f-4879-9a1b-1c2d3e4f5a6b",
"name": "alpha-squad",
"accessCode": "team_Qw3Rt9LmXa7P2VzK",
"logoUrl": null,
"createdAt": "2025-10-17T23:20:47.360Z",
"updatedAt": "2025-10-17T23:20:49.059Z",
"deletedAt": null,
"members": [{"id": "11f9b2ad-6e3c-4a0e-8b0e-7c3b5a9e2d41",
"teamId": "d7a2b1c3-4e5f-4879-9a1b-1c2d3e4f5a6b",
"userId": "4a6e0b7d-8c21-4b6e-a2b1-5f9c0d3e2a74",
"role": "team-owner",
"createdAt": "2025-10-17T23:20:47.511Z",
"updatedAt": "2025-10-17T23:20:47.511Z",
"user": {"id": "4a6e0b7d-8c21-4b6e-a2b1-5f9c0d3e2a74",
"username": "user.alpha@example.com"
}
}
],
"_count": {"websites": 0,
"members": 1
}
},
{"id": "a3c5e7f9-2b41-4d6a-8e0f-1a2b3c4d5e6f",
"name": "beta-team",
"accessCode": "team_Hn8Ks4Md2Qp7Zt0L",
"logoUrl": null,
"createdAt": "2025-10-17T23:11:47.302Z",
"updatedAt": "2025-10-17T23:11:47.302Z",
"deletedAt": null,
"members": [{"id": "c9a7b6e5-d4c3-4b2a-9f18-0e2d3c4b5a6f",
"teamId": "a3c5e7f9-2b41-4d6a-8e0f-1a2b3c4d5e6f",
"userId": "7b2c1d0e-9a8f-4e6d-b3c2-a1f0e9d8c7b6",
"role": "team-owner",
"createdAt": "2025-10-17T23:11:47.456Z",
"updatedAt": "2025-10-17T23:11:47.456Z",
"user": {"id": "7b2c1d0e-9a8f-4e6d-b3c2-a1f0e9d8c7b6",
"username": "user.beta@example.org"
}
}
],
"_count": {"websites": 0,
"members": 1
}
},
{"id": "f1e3d5c7-b9a2-4c6d-8e0f-1a2b3c4d5e70",
"name": "static-team",
"accessCode": "team_Rk5Mn2TpLZ55VvQa",
"logoUrl": null,
"createdAt": "2025-10-17T21:20:22.585Z",
"updatedAt": "2025-10-17T21:20:22.585Z",
"deletedAt": null,
"members": [{"id": "ab34cd56-7890-4123-9def-0a1b2c3d4e5f",
"teamId": "f1e3d5c7-b9a2-4c6d-8e0f-1a2b3c4d5e70",
"userId": "3c2b1a0f-9e8d-4c7b-8a6f-5e4d3c2b1a0f",
"role": "team-owner",
"createdAt": "2025-10-17T21:20:22.738Z",
"updatedAt": "2025-10-17T21:20:22.738Z",
"user": {"id": "3c2b1a0f-9e8d-4c7b-8a6f-5e4d3c2b1a0f",
"username": "user.gamma@example.net"
}
}
],
"_count": {"websites": 0,
"members": 1
}
}
],
"count": 3,
"page": 1,
"pageSize": 20
}

My websites

TBD

Authorizations:

api-keybearer-token

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "0f3a2c5e-9bd8-4c1f-92f7-1a2b3c4d5e6f",
"name": "Staging",
"domain": "staging.example.net",
"shareId": null,
"resetAt": null,
"userId": "5a8e7d9c-1b2f-4a3d-8e9f-0123456789ab",
"teamId": null,
"createdBy": "5a8e7d9c-1b2f-4a3d-8e9f-0123456789ab",
"createdAt": "2025-09-22T11:35:23.635Z",
"updatedAt": "2025-10-17T20:01:05.473Z",
"deletedAt": null,
"user": {"username": "user.alpha@example.com",
"id": "5a8e7d9c-1b2f-4a3d-8e9f-0123456789ab"
}
},
{"id": "7c6b5a49-2e1d-4f3a-8b9c-d0e1f2a3b4c5",
"name": "Website Catalog",
"domain": "catalog.example.org",
"shareId": null,
"resetAt": null,
"userId": "b3c2a1f0-9e8d-4c7b-8a6f-5e4d3c2b1a0f",
"teamId": null,
"createdBy": "b3c2a1f0-9e8d-4c7b-8a6f-5e4d3c2b1a0f",
"createdAt": "2024-10-12T20:41:22.152Z",
"updatedAt": "2025-05-24T13:33:05.745Z",
"deletedAt": null,
"user": {"username": "user.beta@example.org",
"id": "b3c2a1f0-9e8d-4c7b-8a6f-5e4d3c2b1a0f"
}
}
],
"count": 2,
"page": 1,
"pageSize": 20
}

Stats

TBD

Active

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Response samples

200

Content type

application/json

{"visitors": 20
}

Statistics

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

query Parameters

startAt required	number TBD
endAt required	number TBD
unit required	string Enum: "hour" "day" "month" TBD
timezone required	string TBD

Responses

Response samples

200

Content type

application/json

{"pageviews": 20,
"visitors": 20,
"visits": 20,
"bounces": 20,
"totaltime": 20,
"comparison": {"pageviews": 20,
"visitors": 20,
"visits": 20,
"bounces": 20,
"totaltime": 20
}
}

Pageviews

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

query Parameters

compare	string Enum: "prev" "yoy" Previous period or previous year
startAt required	number TBD
endAt required	number TBD
unit required	string Enum: "hour" "day" "month" TBD
timezone required	string TBD

Responses

Response samples

200

Content type

application/json

{"pageviews": [{"x": "2025-10-10T20:10:00Z",
"y": 10
}
],
"sessions": [{"x": "2025-10-10T20:10:00Z",
"y": 15
}
]
}

Metrics

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

x

query Parameters

startAt required	number TBD
endAt required	number TBD
unit required	string Enum: "hour" "day" "month" TBD
timezone required	string TBD
type required	string Enum: "browser" "device" "os" "city" "country" "region" "entry" "exit" "path" "channel" "referrer" TBD

Responses

Response samples

200

Content type

application/json

[{"x": "/",
"y": 20
},
{"x": "/home",
"y": 12
}
]

Realtime

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

x

Responses

Response samples

200

Content type

application/json

{"countries": {"DE": 1
},
"urls": {"/x/": 1
},
"referrers": { },
"events": [{"__type": "pageview",
"sessionId": "e5993b0b-5bf3-5a9f-80e6-f8f49a784563",
"eventName": "",
"createdAt": "2025-10-15T17:45:07Z",
"browser": "safari",
"os": "Mac OS",
"device": "desktop",
"country": "DE",
"urlPath": "/x/",
"referrerDomain": ""
},
{"__type": "session",
"sessionId": "e5993b0b-5bf3-5a9f-80e6-fdf49a7845f3",
"eventName": "",
"createdAt": "2025-10-15T17:45:07Z",
"browser": "safari",
"os": "Mac OS",
"device": "desktop",
"country": "DE",
"urlPath": "/x/",
"referrerDomain": ""
}
],
"series": {"views": [{"x": "2025-10-15T17:45:00Z",
"y": 1
}
],
"visitors": [{"x": "2025-10-15T17:45:00Z",
"y": 1
}
]
},
"totals": {"views": 1,
"visitors": 1,
"events": 0,
"countries": 1
},
"timestamp": 1760550325565
}

Traffic (weekly)

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

query Parameters

startAt required	number TBD
endAt required	number TBD
startDate required	string TBD
endDate required	string TBD
unit required	string Enum: "hour" "day" "month" TBD
timezone required	string TBD

Responses

Response samples

200

Content type

application/json

[[0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
[0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
[0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
1,
0,
0,
0,
0
],
[0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
[0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
[0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
[0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
]

Sessions

TBD

Get all sessions

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

query Parameters

startAt required	number TBD
endAt required	number TBD
startDate required	string TBD
endDate required	string TBD
unit required	string Enum: "hour" "day" "month" TBD
timezone required	string TBD
pageSize required	number TBD

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"websiteId": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
"hostname": ["example.com",
"www.example.com"
],
"browser": "Chrome",
"os": "Windows",
"device": "desktop",
"screen": "1920x1080",
"language": "en-US",
"country": "US",
"region": "California",
"city": "San Francisco",
"firstAt": "2025-10-14T15:00:00Z",
"lastAt": "2025-10-14T15:30:00Z",
"visits": 5,
"views": 12,
"createdAt": "2025-10-14T15:00:00Z"
}
],
"count": 100,
"page": 1,
"pageSize": 10
}

Get properties

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

query Parameters

startAt required	number TBD
endAt required	number TBD
startDate required	string TBD
endDate required	string TBD
unit required	string Enum: "hour" "day" "month" TBD
timezone required	string TBD

Responses

Get session

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Response samples

200

Content type

application/json

{"id": "b2c3d4e5-f6a7-8901-2345-67890abcdef0",
"websiteId": "c7b6a5f0-e9d8-4321-fedc-ba9876543210",
"distinctId": "user-12345",
"browser": "Firefox",
"os": "Linux",
"device": "mobile",
"screen": "375x667",
"language": "fr-FR",
"country": "FR",
"region": "Ile-de-France",
"city": "Paris",
"firstAt": "2025-10-14T16:00:00Z",
"lastAt": "2025-10-14T16:05:00Z",
"visits": 1,
"views": 3,
"events": 5,
"totaltime": 300
}

Session properties

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Session activity

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

query Parameters

startAt required	number TBD
endAt required	number TBD

Responses

Response samples

200

Content type

application/json

[{"createdAt": "2025-10-14T17:00:00Z",
"urlPath": "/home",
"urlQuery": "",
"referrerDomain": "",
"eventId": "c1d2e3f4-a5b6-7890-1234-567890abcde1",
"eventType": 1,
"eventName": "pageview",
"visitId": "d2e3f4a5-b6c7-8901-2345-67890abcdef2",
"hasData": 0
}
]

Events

TBD

Events (activity)

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

query Parameters

startAt required	number TBD
endAt required	number TBD
unit required	string Enum: "hour" "day" "month" TBD
timezone required	string TBD

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "d1e2f3a4-b5c6-7890-1234-567890abcde1",
"websiteId": "e2f3a4b5-c6d7-8901-2345-67890abcdef2",
"sessionId": "f3a4b5c6-d7e8-9012-3456-7890abcdef34",
"createdAt": "2025-10-14T18:00:00Z",
"hostname": "api.example.com",
"urlPath": "/dashboard",
"urlQuery": "",
"referrerPath": "/",
"referrerQuery": "",
"referrerDomain": "internal",
"country": "CA",
"city": "Toronto",
"device": "desktop",
"os": "macOS",
"browser": "Safari",
"pageTitle": "Dashboard Overview",
"eventType": 1,
"eventName": "pageview",
"hasData": 0
}
],
"count": 50,
"page": 1,
"pageSize": 20
}

Event properties

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

query Parameters

startAt required	number TBD
endAt required	number TBD
unit required	string Enum: "hour" "day" "month" TBD
timezone required	string TBD

Responses

Series (chart)

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

query Parameters

startAt required	number TBD
endAt required	number TBD
unit required	string Enum: "hour" "day" "month" TBD
timezone required	string TBD

Responses

Response samples

200

Content type

application/json

[{"x": "Chrome",
"t": "2025-10-14T19:00:00Z",
"y": 150
},
{"x": "Firefox",
"t": "2025-10-14T19:00:00Z",
"y": 80
}
]

Reports

TBD

Breakdown

TBD

Authorizations:

api-keybearer-token

Request Body schema: application/json

websiteId required	string <uuid> TBD
type required	string Value: "breakdown" TBD
	object TBD
required	object TBD

Responses

Request samples

Payload

Content type

application/json

{"websiteId": "eee0b185-ac19-4fd6-bb45-58b59a8988e9",
"type": "breakdown",
"filters": { },
"parameters": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"timezone": "string",
"fields": ["string"
]
}
}

Response samples

200

Content type

application/json

[{"views": 69,
"visitors": 8,
"visits": 7,
"bounces": 2,
"totaltime": 2200,
"path": "/"
}
]

Journey

TBD

Authorizations:

api-keybearer-token

Request Body schema: application/json

websiteId required	string <uuid> TBD
type required	string Value: "journey" TBD
	object TBD
required	object TBD

Responses

Request samples

Payload

Content type

application/json

{"websiteId": "eee0b185-ac19-4fd6-bb45-58b59a8988e9",
"type": "journey",
"filters": { },
"parameters": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"timezone": "string",
"steps": 0,
"startStep": "string",
"endStep": "string"
}
}

Response samples

200

Content type

application/json

[{"items": ["/page1",
"click",
"/page2",
null
],
"count": 150
},
{"items": ["/home",
"/about",
null
],
"count": 25
},
{"items": ["/contact",
"/submit",
null
],
"count": 5
}
]

Retention

TBD

Authorizations:

api-keybearer-token

Request Body schema: application/json

websiteId required	string <uuid> TBD
type required	string Value: "retention" TBD
	object TBD
required	object TBD

Responses

Request samples

Payload

Content type

application/json

{"websiteId": "eee0b185-ac19-4fd6-bb45-58b59a8988e9",
"type": "retention",
"filters": { },
"parameters": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"timezone": "string"
}
}

Attribution

TBD

Authorizations:

api-keybearer-token

Request Body schema: application/json

websiteId required	string <uuid> TBD
type required	string Value: "attribution" TBD
	object TBD
required	object TBD

Responses

Request samples

Payload

Content type

application/json

{"websiteId": "eee0b185-ac19-4fd6-bb45-58b59a8988e9",
"type": "attribution",
"filters": { },
"parameters": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"timezone": "string",
"model": "string",
"type": "string",
"step": "string"
}
}

Revenue

TBD

Authorizations:

api-keybearer-token

Request Body schema: application/json

websiteId required	string <uuid> TBD
type required	string Value: "revenue" TBD
	object TBD
required	object TBD

Responses

Request samples

Payload

Content type

application/json

{"websiteId": "eee0b185-ac19-4fd6-bb45-58b59a8988e9",
"type": "revenue",
"filters": { },
"parameters": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"timezone": "string",
"currency": "string"
}
}

UTM

TBD

Authorizations:

api-keybearer-token

Request Body schema: application/json

websiteId required	string <uuid> TBD
type required	string Value: "utm" TBD
	object TBD
required	object TBD

Responses

Request samples

Payload

Content type

application/json

{"websiteId": "eee0b185-ac19-4fd6-bb45-58b59a8988e9",
"type": "utm",
"filters": { },
"parameters": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"timezone": "string"
}
}

Pixels

TBD

Get all

TBD

Authorizations:

api-keybearer-token

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"name": "My Analytics Site",
"slug": "my-analytics-site",
"userId": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
"teamId": null,
"createdAt": "2024-01-01T10:00:00.000Z",
"updatedAt": "2024-10-14T10:30:00.000Z",
"deletedAt": null
}
],
"count": 1,
"page": 1,
"pageSize": 10
}

Create

TBD

Authorizations:

api-keybearer-token

Request Body schema: application/json

slug required	string TBD
name required	string TBD

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string"
}

Get details

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Response samples

200

Content type

application/json

{"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"name": "My Website Name",
"slug": "my-website-name",
"userId": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
"teamId": null,
"createdAt": "2024-01-01T10:00:00.000Z",
"updatedAt": "2024-10-14T10:30:00.000Z",
"deletedAt": null
}

Update

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

ID of the chess result

Request Body schema: application/json

slug required	string TBD
name required	string TBD

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string"
}

Response samples

200

Content type

application/json

{"ok:": false
}

Delete

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Response samples

200

Content type

application/json

{"ok": true
}

Links

TBD

Get all

TBD

Authorizations:

api-keybearer-token

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"name": "Blog",
"url": "https://example.com/blog",
"slug": "blog-site",
"userId": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
"teamId": null,
"createdAt": "2024-01-01T10:00:00.000Z",
"updatedAt": "2024-10-14T10:30:00.000Z",
"deletedAt": null
}
],
"count": 5,
"page": 1,
"pageSize": 10
}

Create

TBD

Authorizations:

api-keybearer-token

Request Body schema: application/json

slug required	string TBD
name required	string TBD
url required	string <url> TBD

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string",
"url": "string"
}

Get details

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Response samples

200

Content type

application/json

{"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"name": "Test Site",
"url": "https://example.com",
"slug": "test-site",
"userId": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
"teamId": null,
"createdAt": "2024-01-01T10:00:00.000Z",
"updatedAt": "2024-10-14T10:30:00.000Z",
"deletedAt": null
}

Update

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Request Body schema: application/json

slug required	string TBD
name required	string TBD
url required	string <url> TBD

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string",
"url": "string"
}

Delete

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Response samples

200

Content type

application/json

{"ok": true
}

Cohorts & Segments

TBD

Get all

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

query Parameters

client required	string TBD
queryKey required	string Value: "website:segments,[object Object]" TBD
signal required	string TBD
type required	string Enum: "cohort" "segment" TBD

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"websiteId": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
"type": "cohort",
"name": "Checkout Funnel",
"parameters": {"action": {"type": "pageview",
"value": "/checkout/success"
},
"filters": [{"name": "country",
"value": "US",
"operator": "eq"
}
],
"dateRange": "last_30_days"
},
"createdAt": "2024-01-01T10:00:00.000Z",
"updatedAt": "2024-10-14T10:30:00.000Z"
}
],
"count": 1,
"page": 1,
"pageSize": 10
}

Create

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Get details

TBD

Authorizations:

api-keybearer-token

path Parameters

id required	string TBD
_id required	string TBD

Responses

Update

TBD

Authorizations:

api-keybearer-token

path Parameters

id required	string TBD
_id required	string TBD

Responses

Delete

TBD

Authorizations:

api-keybearer-token

path Parameters

id required	string TBD
_id required	string TBD

Responses

Websites

TBD

Get all websites

TBD

Authorizations:

api-keybearer-token

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"name": "Example Name",
"domain": "example.com",
"shareId": null,
"resetAt": null,
"userId": "b2c3d4e5-f678-9012-3456-7890abcdef12",
"teamId": null,
"createdBy": "c3d4e5f6-7890-1234-5678-90abcdef1234",
"createdAt": "2025-10-14T10:00:00.000Z",
"updatedAt": "2025-10-14T10:05:00.000Z",
"deletedAt": null,
"user": {"username": "example_user_name",
"id": "d4e5f678-9012-3456-7890-abcdef123456"
}
}
],
"count": 1,
"page": 1,
"pageSize": 10
}

Create website

TBD

Authorizations:

api-keybearer-token

Request Body schema: application/json

name required	string
domain required	string <hostname>
shareId	null or string [ 8 .. 50 ]

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"domain": "example.com",
"shareId": null
}

Response samples

200

Content type

application/json

{"id": "9293665a-b4bc-4e4a-afde-ddecae0d48b7",
"name": "Demo",
"domain": "example.com",
"shareId": null,
"resetAt": null,
"userId": "e027737a-1884-4a16-8028-e720615747d0",
"teamId": null,
"createdBy": "e027737a-1884-4a16-8028-e720615747d0",
"createdAt": "2025-10-17T19:27:38.269Z",
"updatedAt": "2025-10-17T19:27:38.269Z",
"deletedAt": null
}

Get website details

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Response samples

200

Content type

application/json

{"id": "3a9f8c12-4d57-4e2a-9b3f-0f1a2b3c4d5e",
"name": "Sandbox",
"domain": "app.example.org",
"shareId": null,
"resetAt": null,
"userId": "b1c2d3e4-5f67-489a-9abc-0123456789ab",
"teamId": null,
"createdBy": "b1c2d3e4-5f67-489a-9abc-0123456789ab",
"createdAt": "2025-09-22T11:35:23.635Z",
"updatedAt": "2025-10-17T20:01:05.473Z",
"deletedAt": null
}

Update

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Request Body schema: application/json

name	string
domain	string <hostname>
shareId	string or null <hash> [ 8 .. 50 ] characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"domain": "example.com",
"shareId": null
}

Response samples

200

Content type

application/json

{"id": "9293665a-b4bc-4e4a-afde-ddecae0d48b7",
"name": "Demo",
"domain": "example.com",
"shareId": null,
"resetAt": null,
"userId": "e027737a-1884-4a16-8028-e720615747d0",
"teamId": null,
"createdBy": "e027737a-1884-4a16-8028-e720615747d0",
"createdAt": "2025-10-17T19:27:38.269Z",
"updatedAt": "2025-10-17T19:27:38.269Z",
"deletedAt": null
}

Delete website

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Response samples

200

Content type

application/json

{"ok": true
}

Reset statistics

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Response samples

200

Content type

application/json

{"ok": true
}

Teams

TBD

Get all teams

TBD

Authorizations:

api-keybearer-token

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "3f1c0f3e-1e8b-4d1a-9b8b-5f7e3f0a4c2d",
"name": "alpha-team",
"accessCode": "team_N9x2Qw8Ka3Lp5Zr1",
"logoUrl": null,
"createdAt": "2025-10-05T10:15:30.000Z",
"updatedAt": "2025-10-05T10:15:30.000Z",
"deletedAt": null,
"members": [{"id": "6d0a8f0c-2b1e-4c7a-8d79-2a2b2f8f3b1e",
"teamId": "3f1c0f3e-1e8b-4d1a-9b8b-5f7e3f0a4c2d",
"userId": "a8d7f9b1-5e2f-4a93-9eb5-3b8c2a7e1f40",
"role": "team-owner",
"createdAt": "2025-10-05T10:16:00.000Z",
"updatedAt": "2025-10-05T10:16:00.000Z",
"user": {"id": "a8d7f9b1-5e2f-4a93-9eb5-3b8c2a7e1f40",
"username": "alice"
}
}
],
"_count": {"websites": 2,
"members": 1
}
},
{"id": "9c2e7b14-4b1f-45b8-9d5c-b8e2b7a9e3f1",
"name": "beta-team",
"accessCode": "team_Ty4LmQ7vWd2Hs8P3",
"logoUrl": null,
"createdAt": "2025-10-06T08:00:12.345Z",
"updatedAt": "2025-10-06T08:12:44.123Z",
"deletedAt": null,
"members": [{"id": "f2b9a7c3-7e1d-4c6a-9f3a-1a2b3c4d5e6f",
"teamId": "9c2e7b14-4b1f-45b8-9d5c-b8e2b7a9e3f1",
"userId": "c7a1b2d3-e4f5-6789-abcd-0123456789ab",
"role": "team-owner",
"createdAt": "2025-10-06T08:01:00.000Z",
"updatedAt": "2025-10-06T08:01:00.000Z",
"user": {"id": "c7a1b2d3-e4f5-6789-abcd-0123456789ab",
"username": "bob"
}
}
],
"_count": {"websites": 0,
"members": 1
}
}
],
"count": 2,
"page": 1,
"pageSize": 20
}

Create team

TBD

Authorizations:

api-keybearer-token

Request Body schema: application/json

name

required

string

TBD

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

[{"id": "5f8a7c3e-2d41-4b9a-9c1e-0a2b3c4d5e6f",
"name": "Testing team",
"accessCode": "team_Xy12Ab34Cd56Ef78",
"logoUrl": null,
"createdAt": "2025-10-17T20:56:02.541Z",
"updatedAt": "2025-10-17T20:56:02.541Z",
"deletedAt": null
},
{"id": "9e8d7c6b-5a4f-43e2-9d1c-0b1a2c3d4e5f",
"teamId": "5f8a7c3e-2d41-4b9a-9c1e-0a2b3c4d5e6f",
"userId": "1a2b3c4d-5e6f-4012-9abc-def012345678",
"role": "team-owner",
"createdAt": "2025-10-17T20:56:02.697Z",
"updatedAt": "2025-10-17T20:56:02.697Z"
}
]

Get team details

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Response samples

200

Content type

application/json

{"id": "7f6a1c28-3d9e-4b4b-9f1b-8c2d7e4a1b5c",
"name": "Testing team",
"accessCode": "team_QwErTy1234567890",
"logoUrl": null,
"createdAt": "2025-10-17T20:56:02.541Z",
"updatedAt": "2025-10-17T20:56:02.541Z",
"deletedAt": null,
"members": [{"id": "5e9b1d34-8f23-4a6b-9c71-2d3a4e5f6b7c",
"teamId": "7f6a1c28-3d9e-4b4b-9f1b-8c2d7e4a1b5c",
"userId": "c1b2a3d4-e5f6-4a78-9b01-23456789abcd",
"role": "team-owner",
"createdAt": "2025-10-17T20:56:02.697Z",
"updatedAt": "2025-10-17T20:56:02.697Z"
}
]
}

Update team

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Request Body schema: application/json

name

required

string

TBD

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

{"id": "7f6a1c28-3d9e-4b4b-9f1b-8c2d7e4a1b5c",
"name": "Testing team",
"accessCode": "team_QwErTy1234567890",
"logoUrl": null,
"createdAt": "2025-10-17T20:56:02.541Z",
"updatedAt": "2025-10-17T20:56:02.541Z",
"deletedAt": null
}

Delete team

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Response samples

200

Content type

application/json

{"ok": true
}

Join team

TBD

Authorizations:

api-keybearer-token

Responses

Remove or leave team

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Update member role

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Invite to team

TBD

Authorizations:

api-keybearer-token

Request Body schema: application/json

email required	string <email> TBD
role required	string Enum: "team-owner" "team-admin" "team-member" "team-view-only" TBD
teamId required	string <uuid> TBD

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"role": "team-owner",
"teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec"
}

Response samples

200

Content type

application/json

{"ok": true
}

Helper

Helper requests

Date range

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

Responses

Response samples

200

Content type

application/json

{"startDate": "2023-09-11T09:00:00Z",
"endDate": "2023-09-17T18:00:00Z"
}

Values

TBD

Authorizations:

api-keybearer-token

path Parameters

id

required

string

TBD

query Parameters

type required	string Enum: "event" "path" TBD
startAt required	number TBD
endAt required	number TBD

Responses

Response samples

200

Content type

application/json

[{"value": "category_a",
"count": 42
},
{"value": "category_b",
"count": 105
}
]