---
title: "Create a goal"
method: POST
path: "/v1/projects/{projectId}/goals"
tags: ["Goals"]
---

# Create a goal

`POST /v1/projects/{projectId}/goals`

## Request

- Base URL: `https://hootlens-api-368877148687.us-east1.run.app`
- URL: `https://hootlens-api-368877148687.us-east1.run.app/v1/projects/{projectId}/goals`
- Auth: HTTP bearer

A click goal matches an element by CSS selector, data-hoot-id or label text; a page goal matches a page path pattern. Needs an owner or editor; personal access tokens receive 403. A site can have 20 goals.

Required token scopes are listed in x-hootlens-scopes. A signed-in person needs the matching permission on the site instead (the viewer and editor roles are presets of the permissions).

## Path parameters

- `projectId` string, required: An identifier: 1 to 80 letters, digits, underscores or hyphens.

## Request body

- union
  - object
    - `kind` 'click', required
    - `name` string, required
    - `by` 'selector', required
    - `match` string, required
  - object
    - `kind` 'click', required
    - `name` string, required
    - `by` 'hootId', required
    - `match` string, required
  - object
    - `kind` 'click', required
    - `name` string, required
    - `by` 'label', required
    - `match` string, required
  - object
    - `kind` 'page', required
    - `name` string, required
    - `match` string, required

## Response `201`

The new goal.

- object
  - `goal` union, required
    - object
      - `kind` 'click', required
      - `name` string, required
      - `by` 'selector', required
      - `match` string, required
      - `id` string, required
      - `since` integer, required
    - object
      - `kind` 'click', required
      - `name` string, required
      - `by` 'hootId', required
      - `match` string, required
      - `id` string, required
      - `since` integer, required
    - object
      - `kind` 'click', required
      - `name` string, required
      - `by` 'label', required
      - `match` string, required
      - `id` string, required
      - `since` integer, required
    - object
      - `kind` 'page', required
      - `name` string, required
      - `match` string, required
      - `id` string, required
      - `since` integer, required

## Other responses

- `400`: The request fields are invalid.
- `401`: The credential is missing, expired or revoked.
- `403`: The credential or the person's permissions on the site do not permit this action.
- `404`: The site, or the record inside it, does not exist or the caller is not a member (a non-member cannot tell the two apart).
- `429`: A rate limit or a per-site limit was reached.

---

[API](https://skmtc.dev/hootlens/apis/hoot-lens-api.md) · [All operations](https://skmtc.dev/hootlens/apis/hoot-lens-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hootlens/apis/hoot-lens-api/revisions/f64f8dc7b84e?raw)