{"_id":"590fb7ab562f90190067ad60","parentDoc":null,"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"},"project":"5588b8a2f6c18d0d005bba03","user":"5588b847f6c18d0d005bba01","__v":0,"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-08T00:11:23.416Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"patch","results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"590fb76235cf270f008e95d9","ref":"","in":"body","required":false,"desc":"The title of the report","default":"'Untitled report'","type":"string","name":"title"},{"_id":"590fb76235cf270f008e95d8","ref":"","in":"body","required":false,"desc":"The recipient email address the report results are limited to","default":"","type":"string","name":"to"},{"_id":"590fb76235cf270f008e95d7","ref":"","in":"body","required":false,"desc":"The name of the sequence report results are limited to, or '*' if the report results show data for all sequence messages","default":"","type":"string","name":"sequence"},{"_id":"590fb76235cf270f008e95d6","ref":"","in":"body","required":false,"desc":"The name of the template report results are limited to, or '*' if the report results show data for all template messages","default":"","type":"string","name":"template"},{"_id":"590fb76235cf270f008e95d5","ref":"","in":"body","required":false,"desc":"The date range the report will show. One of 'today', 'yesterday', 'last7', 'thisWeek', 'lastWeek', 'last30', 'thisMonth', 'lastMonth', 'last12Months', 'thisYear', 'lastYear' or 'specific'.","default":"'last30'","type":"string","name":"dates"},{"_id":"590fb76235cf270f008e95d4","ref":"","in":"body","required":false,"desc":"If `dates` is 'specific', the date range lower bound (in ms).","default":"","type":"string","name":"since"},{"_id":"590fb76235cf270f008e95d3","ref":"","in":"body","required":false,"desc":"If `dates` is 'specific', the date range upper bound (in ms).","default":"","type":"string","name":"until"}],"url":"/v1/insightsreports/:id"},"isReference":true,"order":31,"body":"","excerpt":"","slug":"insightsreports-2","type":"endpoint","title":"/insightsreports/:id"}

patch/insightsreports/:id


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

title:
string'Untitled report'
The title of the report
to:
string
The recipient email address the report results are limited to
sequence:
string
The name of the sequence report results are limited to, or '*' if the report results show data for all sequence messages
template:
string
The name of the template report results are limited to, or '*' if the report results show data for all template messages
dates:
string'last30'
The date range the report will show. One of 'today', 'yesterday', 'last7', 'thisWeek', 'lastWeek', 'last30', 'thisMonth', 'lastMonth', 'last12Months', 'thisYear', 'lastYear' or 'specific'.
since:
string
If `dates` is 'specific', the date range lower bound (in ms).
until:
string
If `dates` is 'specific', the date range upper bound (in ms).

User Information

Try It Out

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