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

List conversion goals for a Clics project via REST

Copy page

List conversion goals for a Clics project via REST

List project conversion goals.

GET/v1/projects/{project_id}/goals
Authorization
AuthorizationBearer token (API key) · headerrequired
Path parameters
project_idstringrequired
Clics project ID.
min length 1
Query parameters
env_idstring
Optional environment. Defaults to `production`. Use `development` for localhost/dev traffic.
default: "production"
Allowed:productiondevelopment
Responses
200Goals for a project environment.
goalsGoal[]required
Show properties
Array of Goal
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/projects/k17abc123/goals" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "goals": [
    {
      "id": "string",
      "project_id": "string",
      "env_id": "production",
      "display_name": "string"
    }
  ]
}