{"_id":"576beb8874a8640e004cece6","parentDoc":null,"project":"55a7ff613efe0c2f0074cbe4","__v":0,"category":{"_id":"576beb8874a8640e004cecdd","__v":0,"version":"576beb8874a8640e004cecda","project":"55a7ff613efe0c2f0074cbe4","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-19T18:18:09.420Z","from_sync":false,"order":2,"slug":"api-engagement","title":"API - Reports"},"editedParams":true,"version":{"_id":"576beb8874a8640e004cecda","project":"55a7ff613efe0c2f0074cbe4","__v":2,"createdAt":"2016-06-23T14:00:40.149Z","releaseDate":"2016-06-23T14:00:40.149Z","categories":["576beb8874a8640e004cecdb","576beb8874a8640e004cecdc","576beb8874a8640e004cecdd","576beb8874a8640e004cecde","576beb8874a8640e004cecdf","576beb8874a8640e004cece0","576beb8874a8640e004cece1","58ee8a5737e50a2f00d12147"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"editedParams2":true,"user":"55a7ff4f3efe0c2f0074cbe2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-18T21:15:03.791Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n  \"groupNames\" : \n  [\n    \"officevibe\"\n  ],\n  \"date\" : \n  [\n    \"2016-06-02\"\n  ]\n}"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n  \"weeklyReports\" :\n  [\n    {\n      \"date\" : \"2016-06-02\",\n      \"groupName\" : \"Officevibe\",\n      \"metricsValues\" :\n      [\n        {\n          \"id\"  : \"MG-10\",\n          \"displayName\" : \"Ambassadorship\",\n          \"value\" : 8.5\n        }\n      ]\n    }\n  ]\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"573cdc36a5de210e00875cd8","ref":"","in":"body","required":false,"desc":"If null returns the engagement reports for all company users","default":"null","type":"array_string","name":"groupNames"},{"_id":"573cdc36a5de210e00875cd7","ref":"","in":"body","required":true,"desc":"There is a limit of 20 dates.","default":"","type":"array_yyyy-mm-dd","name":"dates"}],"url":"/engagement"},"isReference":true,"order":0,"body":"","excerpt":"The request returns the engagement reports for a list of dates and groups specified.","slug":"engagement","type":"endpoint","title":"/engagement"}

post/engagement

The request returns the engagement reports for a list of dates and groups specified.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

groupNames:
array of stringsnull
If null returns the engagement reports for all company users
dates:
required
array of yyyy-mm-dd
There is a limit of 20 dates.

Examples


Result Format


User Information

Try It Out

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