Skip to content
Clics privacy-friendly cookieless web analytics documentation
Esc
navigateopen⌘Jpreview

Get a conversion goal by ID

Copy page

Get a conversion goal by ID

Fetch one Goal, including its type-specific rule.

GET/v1/goals/{goal_id}
Authorization
AuthorizationBearer token (API key) · headerrequired
Path parameters
goal_idstringrequired
min length 1
Responses
200Goal details.
idstringrequired
project_idstringrequired
env_idstringrequired
Allowed:productiondevelopment
display_namestringrequired
400Invalid request.
errorobjectrequired
Show properties
codestringrequired
messagestringrequired
401Missing or invalid API key.
errorobjectrequired
Show properties
codestringrequired
messagestringrequired
403Forbidden.
errorobjectrequired
Show properties
codestringrequired
messagestringrequired
404Resource not found.
errorobjectrequired
Show properties
codestringrequired
messagestringrequired
500Unexpected error.
errorobjectrequired
Show properties
codestringrequired
messagestringrequired
Request
curl -X GET "https://api.clics.dev/v1/goals/goal_1" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "id": "string",
  "project_id": "string",
  "env_id": "production",
  "display_name": "string"
}