Create a conversion goal on a Clics project via REST

Create a page, event, outbound-link, or scroll-depth goal.

POST/v1/projects/{project_id}/goals

Authorization

AuthorizationBearer token (API key) · headerrequired

Path parameters

project_idstringrequired

Clics project ID.

min length 1

Request body

requiredapplication/json

env_idstring

Optional environment. Defaults to `production`. Use `development` for localhost/dev traffic.

default: "production"

Allowed:productiondevelopment

display_namestringrequired

Goal display name.

min length 1

Responses

200Created 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 POST "https://api.clics.dev/v1/projects/k17abc123/goals" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "env_id": "production",
  "goal_type": "page",
  "display_name": "Signup",
  "rule": {
    "page_path": "/signup"
  }
}'

const response = await fetch("https://api.clics.dev/v1/projects/k17abc123/goals", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "env_id": "production",
  "goal_type": "page",
  "display_name": "Signup",
  "rule": {
    "page_path": "/signup"
  }
})
});

import requests

response = requests.post(
    "https://api.clics.dev/v1/projects/k17abc123/goals",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "env_id": "production",
  "goal_type": "page",
  "display_name": "Signup",
  "rule": {
    "page_path": "/signup"
  }
},
)

Response

{
  "id": "string",
  "project_id": "string",
  "env_id": "production",
  "display_name": "string"
}