PIpiwik
Analytics

Get custom dimension

Changed on

Returns a definition of a specific custom dimension.

get/api/analytics/v1/manage/custom-dimensions/{id}/

Request

Path parameters

idstring uuid required

ID of the object.

Query parameters

website_idstring uuid required

ID of the website.

Response

OK

Example response

{
  "data": {
    "id": "677fe0d3-b4f7-43ed-852d-1a9e7b8e59fb",
    "attributes": {
      "website_id": "dde2dc68-b6bb-45ee-9ac2-868b6181e33f",
      "name": "Visitor hair color",
      "extractions": [
        {
          "pattern": "/foo/(.*)/bar"
        }
      ]
    }
  }
}

Changes

  • 8b8abe1ab4f1Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status