List goals configured for a site

GET

/v1/goals

curl --request GET \
  --url 'https://api.pomeloanalytics.com/v1/goals?site_id=example' \
  --header 'Authorization: Bearer <token>'

Read-only goal listing. Goals are created and managed from the Pomelo dashboard, then exposed here for API consumers. This endpoint is not metered.

Authorizations

• bearerAuth

Parameters

Header Parameters

X-Request-Id

string

Optional idempotency/request correlation identifier.

Query Parameters

site_id

required

string

Responses

200

OK

Media typeapplication/json

object

items

required

Array<object>

object

goalId

required

string

siteId

required

string

orgId

required

string

name

required

string

type

required

string

Allowed values: PAGEVIEW_MATCH EVENT_MATCH

intent

required

string

Allowed values: lead signup purchase download outbound content custom

pattern

required

string

filters

object

action_id

string

action_target_host

string

form_id

string

form_action_path

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "items": [
    {
      "type": "PAGEVIEW_MATCH",
      "intent": "lead"
    }
  ]
}

Headers

X-Request-Id

string

Request identifier for troubleshooting.

401

Invalid or revoked API token.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHORIZED FORBIDDEN INVALID_METHOD INVALID_PARAMS RETENTION_EXCEEDED RATE_LIMITED HARD_CAP_REACHED REPORT_LOCKED_BY_PROFILE REPORT_NOT_AVAILABLE_FOR_REQUESTED_PERIOD REPORT_RESPONSE_TOO_LARGE INTERNAL_ERROR NOT_FOUND

message

required

string

request_id

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "UNAUTHORIZED"
  }
}

Headers

X-Request-Id

string

Request identifier for troubleshooting.

403

Token scope/site/plan does not allow this request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHORIZED FORBIDDEN INVALID_METHOD INVALID_PARAMS RETENTION_EXCEEDED RATE_LIMITED HARD_CAP_REACHED REPORT_LOCKED_BY_PROFILE REPORT_NOT_AVAILABLE_FOR_REQUESTED_PERIOD REPORT_RESPONSE_TOO_LARGE INTERNAL_ERROR NOT_FOUND

message

required

string

request_id

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "UNAUTHORIZED"
  }
}

Headers

X-Request-Id

string

Request identifier for troubleshooting.

422

Request parameters are invalid.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHORIZED FORBIDDEN INVALID_METHOD INVALID_PARAMS RETENTION_EXCEEDED RATE_LIMITED HARD_CAP_REACHED REPORT_LOCKED_BY_PROFILE REPORT_NOT_AVAILABLE_FOR_REQUESTED_PERIOD REPORT_RESPONSE_TOO_LARGE INTERNAL_ERROR NOT_FOUND

message

required

string

request_id

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "UNAUTHORIZED"
  }
}

Headers

X-Request-Id

string

Request identifier for troubleshooting.

429

Request was throttled.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHORIZED FORBIDDEN INVALID_METHOD INVALID_PARAMS RETENTION_EXCEEDED RATE_LIMITED HARD_CAP_REACHED REPORT_LOCKED_BY_PROFILE REPORT_NOT_AVAILABLE_FOR_REQUESTED_PERIOD REPORT_RESPONSE_TOO_LARGE INTERNAL_ERROR NOT_FOUND

message

required

string

request_id

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "UNAUTHORIZED"
  }
}

Headers

X-Request-Id

string

Request identifier for troubleshooting.

X-RateLimit-Limit

integer

Maximum requests allowed during current short window.

X-RateLimit-Remaining

integer

Remaining requests in current short window.

X-RateLimit-Reset

integer

Unix timestamp when short window resets.