Ingest server-side SDK analytics event (page_visit)
curl --request POST \
--url https://app.promptingco.com/api/v1/analytics/events \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"event": "page_visit",
"page": {
"href": "<string>",
"domain": "<string>",
"pathname": "<string>",
"title": "<string>",
"canonicalUrl": "<string>"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event: 'page_visit',
page: {
href: '<string>',
domain: '<string>',
pathname: '<string>',
title: '<string>',
canonicalUrl: '<string>'
}
})
};
fetch('https://app.promptingco.com/api/v1/analytics/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.promptingco.com/api/v1/analytics/events"
payload = {
"event": "page_visit",
"page": {
"href": "<string>",
"domain": "<string>",
"pathname": "<string>",
"title": "<string>",
"canonicalUrl": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"data": {
"ok": true,
"data": {
"accepted": true,
"eventId": "<string>",
"status": "accepted",
"receivedAt": "2023-11-07T05:31:56Z"
}
}
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}Visibility & Mentions
Ingest server-side SDK analytics event (page_visit)
POST
/
api
/
v1
/
analytics
/
events
Ingest server-side SDK analytics event (page_visit)
curl --request POST \
--url https://app.promptingco.com/api/v1/analytics/events \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"event": "page_visit",
"page": {
"href": "<string>",
"domain": "<string>",
"pathname": "<string>",
"title": "<string>",
"canonicalUrl": "<string>"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event: 'page_visit',
page: {
href: '<string>',
domain: '<string>',
pathname: '<string>',
title: '<string>',
canonicalUrl: '<string>'
}
})
};
fetch('https://app.promptingco.com/api/v1/analytics/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.promptingco.com/api/v1/analytics/events"
payload = {
"event": "page_visit",
"page": {
"href": "<string>",
"domain": "<string>",
"pathname": "<string>",
"title": "<string>",
"canonicalUrl": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"data": {
"ok": true,
"data": {
"accepted": true,
"eventId": "<string>",
"status": "accepted",
"receivedAt": "2023-11-07T05:31:56Z"
}
}
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}Authorizations
apiKeyAuthbearerAuthcookieAuth
Organization-scoped API key. Available scopes:
- content:read: Read site pages, markdown content, and llms.txt files
- content:write: Create, update, and delete site pages and content
- prompts:read: Read prompts, topics, prompt suggestions, and prompt analysis results
- prompts:write: Create, update, archive prompts and generate, edit, or review prompt suggestions
- simulations:read: Read agent-simulation tasks, runs, environments, and analytics
- simulations:write: Create and trigger simulation runs
- logs:read: Read AI-traffic logs and request-level audit events
- analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
- analytics:write: Write events to analytics
- products:read: Read product metadata and competitor data
- products:write: Update product settings and competitor lists
Body
application/json
Available options:
page_visit Show child attributes
Show child attributes
Minimum string length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes