---
title: Get widget analytics results
slug: get-widget-analytics-results
docTags: 
createdAt: 2026-05-04T13:13:49.254Z
---

{
  "id": "Uf4SEsrXZCzi5hR8HelKB",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "/v1/widgets/{id}/results",
    "servers": [],
    "name": "Get widget analytics results",
    "description": "",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "id",
          "type": "string",
          "description": "",
          "pattern": "\\d+"
        }
      ],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "websiteId",
          "type": "string",
          "description": "",
          "default": null,
          "pattern": "\\d+"
        },
        {
          "kind": "optional",
          "name": "goal",
          "type": "string",
          "description": "",
          "default": null,
          "pattern": "\\d+"
        },
        {
          "kind": "optional",
          "name": "filters",
          "type": "object",
          "description": "<p>Report filters as a map. Use as ?filters[fieldName]=value (or ?filters[fieldName][]=v1&#x26;filters[fieldName][]=v2 for arrays).</p>",
          "schema": [
            {
              "name": "dateFrom",
              "kind": "optional",
              "type": "string<date-time>",
              "description": "",
              "format": "date-time"
            },
            {
              "name": "dateTo",
              "kind": "optional",
              "type": "string<date-time>",
              "description": "",
              "format": "date-time"
            },
            {
              "name": "device",
              "kind": "optional",
              "type": "array",
              "description": "",
              "example": "",
              "itemType": "string",
              "customType": "string[]",
              "itemExample": "",
              "itemDefault": ""
            },
            {
              "name": "browser",
              "kind": "optional",
              "type": "array",
              "description": "",
              "example": "",
              "itemType": "string",
              "customType": "string[]",
              "itemExample": "",
              "itemDefault": ""
            },
            {
              "name": "os",
              "kind": "optional",
              "type": "array",
              "description": "",
              "example": "",
              "itemType": "string",
              "customType": "string[]",
              "itemExample": "",
              "itemDefault": ""
            },
            {
              "name": "country",
              "kind": "optional",
              "type": "array",
              "description": "",
              "example": "",
              "itemType": "string",
              "customType": "string[]",
              "itemExample": "",
              "itemDefault": ""
            },
            {
              "name": "region",
              "kind": "optional",
              "type": "array",
              "description": "",
              "example": "",
              "itemType": "string",
              "customType": "string[]",
              "itemExample": "",
              "itemDefault": ""
            },
            {
              "name": "city",
              "kind": "optional",
              "type": "array",
              "description": "",
              "example": "",
              "itemType": "string",
              "customType": "string[]",
              "itemExample": "",
              "itemDefault": ""
            },
            {
              "name": "utmSource",
              "kind": "optional",
              "type": "string",
              "description": ""
            },
            {
              "name": "utmMedium",
              "kind": "optional",
              "type": "string",
              "description": ""
            },
            {
              "name": "utmCampaign",
              "kind": "optional",
              "type": "string",
              "description": ""
            },
            {
              "name": "utmContent",
              "kind": "optional",
              "type": "string",
              "description": ""
            },
            {
              "name": "utmTerm",
              "kind": "optional",
              "type": "string",
              "description": ""
            },
            {
              "name": "referrer",
              "kind": "optional",
              "type": "string",
              "description": ""
            },
            {
              "name": "firstVisitPage",
              "kind": "optional",
              "type": "string",
              "description": ""
            },
            {
              "name": "visitorType",
              "kind": "optional",
              "type": "string<new | returning>",
              "description": "",
              "enum": [
                "new",
                "returning"
              ]
            },
            {
              "name": "goalValue",
              "kind": "optional",
              "type": "number",
              "description": ""
            },
            {
              "name": "zScore",
              "kind": "optional",
              "type": "number",
              "description": ""
            }
          ]
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "bearer",
          "name": "bearer",
          "kind": "optional",
          "type": "http",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Returned when successful",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "404",
        "description": "Widget not found",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "FFvh8mzAVpVdySdpqY0t2",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url '/v1/widgets/{id}/results?websiteId=string&goal=string&filters=object' \\\n     --header 'accept: application/json'"
        },
        {
          "id": "XJSpUcnD_1u4IqiOeupDd",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"/v1/widgets/{id}/results?websiteId=string&goal=string&filters=object\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "AXA_YuKX_YEw6BtyD7BTp",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/v1/widgets/{id}/results?websiteId=string&goal=string&filters=object\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "6XFrZnXcEmBD1SN-8djwn",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"/v1/widgets/{id}/results?websiteId=string&goal=string&filters=object\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "FFvh8mzAVpVdySdpqY0t2"
    },
    "results": {
      "languages": [
        {
          "id": "rFxpyaZNWkO01MirGXzG7",
          "language": "200",
          "code": "// Returned when successful\n"
        },
        {
          "id": "aHYmnMvJntM6JxXnCJeDV",
          "language": "404",
          "code": "// Widget not found\n"
        }
      ],
      "selectedLanguageId": "rFxpyaZNWkO01MirGXzG7"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}