{"_id":"590fb4d4656b640f0084fe13","category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API"},"version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":15,"createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":0,"parentDoc":null,"project":"5588b8a2f6c18d0d005bba03","user":"5588b847f6c18d0d005bba01","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-07T23:59:16.408Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/insightsreports","language":"curl"}]},"method":"get","results":{"codes":[]},"auth":"required","params":[],"url":"/v1/insightsreports"},"isReference":true,"order":29,"body":"[block:api-header]\n{\n  \"title\": \"Response Format\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"_id\",\n    \"0-1\": \"*String*\",\n    \"0-2\": \"Unique ID\",\n    \"1-0\": \"userId\",\n    \"1-1\": \"*String*\",\n    \"1-2\": \"The ID of the user who owns the report\",\n    \"2-0\": \"title\",\n    \"2-1\": \"*String*\",\n    \"2-2\": \"The title of the report. May be blank.\",\n    \"3-0\": \"to\",\n    \"3-1\": \"*String*\",\n    \"3-2\": \"The recipient email address the report results are limited to. Optional.\",\n    \"4-0\": \"sequence\",\n    \"4-1\": \"*String*\",\n    \"4-2\": \"The name of the sequence report results are limited to, or '*' if the report results show data for all sequence messages. Optional.\",\n    \"5-0\": \"template\",\n    \"5-1\": \"*String*\",\n    \"5-2\": \"The name of the template report results are limited to, or '*' if the report results show data for all template messages. Optional.\",\n    \"6-0\": \"dates\",\n    \"6-1\": \"*String*\",\n    \"6-2\": \"The date range the report will show. One of 'today', 'yesterday', 'last7', 'thisWeek', 'lastWeek', 'last30', 'thisMonth', 'lastMonth', 'last12Months', 'thisYear', 'lastYear' or 'specific'.\",\n    \"7-0\": \"since\",\n    \"7-1\": \"*Integer*\",\n    \"7-2\": \"If `dates` is 'specific', the date range lower bound (in ms).\",\n    \"8-0\": \"until\",\n    \"8-1\": \"*Integer*\",\n    \"8-2\": \"If `dates` is 'specific', the date range upper bound (in ms).\",\n    \"9-0\": \"createdAt\",\n    \"9-1\": \"*Date*\",\n    \"9-2\": \"The date the report was created.\",\n    \"10-0\": \"updatedAt\",\n    \"10-1\": \"*Date*\",\n    \"10-2\": \"The date the report was last modified.\",\n    \"11-0\": \"shared\",\n    \"11-1\": \"*Object*\",\n    \"11-2\": \"See [format](/docs/shared).\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","excerpt":"","slug":"insightsreports","type":"endpoint","title":"/insightsreports"}

get/insightsreports


Definition

{{ api_url }}{{ page_api_url }}

Examples


Documentation

[block:api-header] { "title": "Response Format" } [/block] [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "_id", "0-1": "*String*", "0-2": "Unique ID", "1-0": "userId", "1-1": "*String*", "1-2": "The ID of the user who owns the report", "2-0": "title", "2-1": "*String*", "2-2": "The title of the report. May be blank.", "3-0": "to", "3-1": "*String*", "3-2": "The recipient email address the report results are limited to. Optional.", "4-0": "sequence", "4-1": "*String*", "4-2": "The name of the sequence report results are limited to, or '*' if the report results show data for all sequence messages. Optional.", "5-0": "template", "5-1": "*String*", "5-2": "The name of the template report results are limited to, or '*' if the report results show data for all template messages. Optional.", "6-0": "dates", "6-1": "*String*", "6-2": "The date range the report will show. One of 'today', 'yesterday', 'last7', 'thisWeek', 'lastWeek', 'last30', 'thisMonth', 'lastMonth', 'last12Months', 'thisYear', 'lastYear' or 'specific'.", "7-0": "since", "7-1": "*Integer*", "7-2": "If `dates` is 'specific', the date range lower bound (in ms).", "8-0": "until", "8-1": "*Integer*", "8-2": "If `dates` is 'specific', the date range upper bound (in ms).", "9-0": "createdAt", "9-1": "*Date*", "9-2": "The date the report was created.", "10-0": "updatedAt", "10-1": "*Date*", "10-2": "The date the report was last modified.", "11-0": "shared", "11-1": "*Object*", "11-2": "See [format](/docs/shared)." }, "cols": 3, "rows": 12 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}