Analytics

Get goal

Returns a definition of a specific goal. Please note that each request must be authenticated.

get/api/analytics/v1/manage/goals/{id}/

Request

Base URL
https://example.piwik.pro
Auth
OAuth 2
Client credentials
Token URL/auth/token
TypeScript
https://skmtc.dev/piwik/apis/web-api/docs/api/analytics/v1/manage/goals/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

ID of the object.

Query parameters

website_idstring uuid required

ID of the website.

Response

Example response

{
  "data": {
    "id": "dde2dc68-b6bb-45ee-9ac2-868b6181e33f",
    "attributes": {
      "website_id": "dde2dc68-b6bb-45ee-9ac2-868b6181e33f",
      "name": "User entered contact page",
      "description": "Goal is triggered when user enters contact page",
      "trigger": "url",
      "pattern_type": "contains",
      "pattern": "Contact",
      "revenue": "10.22"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.