Goals

Get website goal

GET/api/websites/{websiteId}/goals/{goalId}

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Name	Type	Description
websiteIdrequired	string	ID of the website.
goalIdrequired	string

200The operation completed successfully.

Name	Type	Description
okrequired	any	Whether the operation succeeded.

200 example

{
  "ok": {}
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

404Not found.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

404 example

{
  "error": {
    "code": "not-found",
    "message": "Not found.",
    "status": 404
  }
}

cURL

curl -X GET 'https://api.example.com/api/websites/{websiteId}/goals/{goalId}' \
  -H 'Authorization: Bearer <token>'