Reference

Reports and insights API

12 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI document Errors and rate limits SDK and CLI recipes

On this page

reports.answerFeedback

Read feedback on Mello's answers

POST/api/v1/manage/reports/answerFeedback

Read
Permission reports.answerFeedback

const result = await shuffl.reports.answerFeedback({});

Request fields (1)

days 7 | 30 | 90 optional

Response object

days number required
down number required
recent object[] required
- at string required
- note null | string required
- rating "down" | "up" required
- sources object[] required
  - sourceId string required
  - title string required
up number required

reports.celebrations

Celebrations sent, people celebrated, birthdays and anniversaries, shared with the team, team cards and notes, share answers and missed messages over 30, 90 or 180 days against the period before, with a weekly series

POST/api/v1/manage/reports/celebrations

Read
Permission reports.celebrations

const result = await shuffl.reports.celebrations({});

Request fields (1)

days 30 | 90 | 180 optional

Response object

cards object required
- current object required
  - delivered number required
  - notes number required
- previous object required
  - delivered number required
  - notes number required
consent object required
- private number required
- share number required
- waiting number required
end string (date-time) required
missed object required
- failed number required
- skipped number required
sent object required
- current object required
  - anniversaries number required
  - birthdays number required
  - people number required
  - shared number required
  - total number required
- previous object required
  - anniversaries number required
  - birthdays number required
  - people number required
  - shared number required
  - total number required
start string (date-time) required
weekly object[] required
- anniversaries number required
- birthdays number required
- week string required
window 30 | 90 | 180 required

reports.connections

Read Connections insights

POST/api/v1/manage/reports/connections

Read
Permission reports.connections

const result = await shuffl.reports.connections({});

Request fields (2)

days 30 | 90 | 180 optional
programId string optional

Response object

end string (date-time) required
introductions object required
- current object required
  - groups number required
  - people number required
- previous object required
  - groups number required
  - people number required
pairs object required
- acrossTeams number required
- firstTime number required
- total number required
- withTeams number required
participation object required
- inChannel number required
- onBreak number required
- takingPart number required
start string (date-time) required
weekly object[] required
- groups number required
- people number required
- week string required
window 30 | 90 | 180 required

reports.knowledge

Read Knowledge activity

POST/api/v1/manage/reports/knowledge

Read
Permission reports.knowledge

const result = await shuffl.reports.knowledge({});

Request fields (1)

days 7 | 30 | 90 optional

Response object

attention object[] required
- kind "no_match" | "no_permitted_sources" | "pending_verification" | "review_overdue" | "revoked_or_conflicting" | "stale" | "withdrawn" | "withheld" required
- measured object required
  - Option 1 object optional
    status "available" required
    value number required
  - Option 2 object optional
    status "suppressed" required
collectionStartedAt null | string (date-time) required
coverage "complete" | "partial" | "unavailable" required
hr object required
- confirmationDenominator number required
- current object required
  - casesOpened number required
  - casesReopened number required
  - casesWithAReply number required
  - closedByHr number required
  - confirmedByRequester number required
  - resolvedActorUnknown number required
- previous object required
  - casesOpened number required
  - casesReopened number required
  - casesWithAReply number required
  - closedByHr number required
  - confirmedByRequester number required
  - resolvedActorUnknown number required
knowledge object required
- byDay object[] required
  - day string required
  - kind "cited" | "guidance_proposed" | "guidance_reused" | "guidance_verified" | "no_evidence" | "retrieved" required
  - total number required
- current object required
  - answeredWithEvidence number required
  - citedSuppressed object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - denominator number required
  - noEvidence number required
  - noEvidenceSuppressed object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - retrieved number required
- funnel object required
  - proposed number required
  - reused number required
  - verified number required
- previous object required
  - answeredWithEvidence number required
  - denominator number required
  - noEvidence number required
  - retrieved number required
- sources object[] required
  - cited object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - citedBefore object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - pendingProposalId null | string required
  - publishedAt null | string (date-time) required
  - retrieved object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - retrievedBefore object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - revision null | number required
  - sourceId string required
  - state "archived" | "published" | "unreadable" | "withdrawn" required
  - title null | string required
  - updatedAt null | string (date-time) required
  - withdrawalReason null | "access_lost" | "hr" required
openNow object required
units object required
- answeredWithEvidence string required
- casesOpened string required
- denominator string required
- retrieved string required
window 7 | 30 | 90 required
windowEnd string (date-time) required
windowStart string (date-time) required

reports.knowledgeSource

Read activity for one Knowledge source

POST/api/v1/manage/reports/knowledgeSource

Read
Permission reports.knowledgeSource

const result = await shuffl.reports.knowledgeSource({
  "sourceId": "<sourceId>"
});

Request fields (2)

days 7 | 30 | 90 optional
sourceId string required

Response object

cited object required
- Option 1 object optional
  - status "available" required
  - value number required
- Option 2 object optional
  - status "suppressed" required
citedBefore object required
- Option 1 object optional
  - status "available" required
  - value number required
- Option 2 object optional
  - status "suppressed" required
coverage "complete" | "partial" | "unavailable" required
pendingProposalId null | string required
retrieved object required
- Option 1 object optional
  - status "available" required
  - value number required
- Option 2 object optional
  - status "suppressed" required
retrievedBefore object required
- Option 1 object optional
  - status "available" required
  - value number required
- Option 2 object optional
  - status "suppressed" required
window 7 | 30 | 90 required
windowEnd string (date-time) required
windowStart string (date-time) required

reports.melloTrial

What Mello handled during the trial, from day 25 of a trial until it ends

POST/api/v1/manage/reports/melloTrial

Read
Permission reports.melloTrial

const result = await shuffl.reports.melloTrial();

Request fields (none)

This operation takes no input.

Response null | object

The response is null | object.

reports.melloValue

What Mello handled this week, this month and all time, with time saved once the team has set its minutes per question

POST/api/v1/manage/reports/melloValue

Read
Permission reports.melloValue

const result = await shuffl.reports.melloValue();

Request fields (none)

This operation takes no input.

Response object

allTime object required
- coverage string required
- current object required
  - actions object required
    answers object required
    appActionsDone object required
    buddyAccepted object required
    hrRequestsSent object required
    playbookMessagesSent object required
    praiseTiedToValues object required
  - answered object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - end string (date-time) required
  - handledShare null | number required
  - handledWithoutHr object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - questions object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - start string (date-time) required
  - total number required
  - unknown object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - wentToHr object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
- minutesSaved null | number required
collectionStartedAt null | string (date-time) required
minutesPerQuestion null | number required
month object required
- coverage "complete" | "partial" | "unavailable" required
- current object required
  - actions object required
    answers object required
    appActionsDone object required
    buddyAccepted object required
    hrRequestsSent object required
    playbookMessagesSent object required
    praiseTiedToValues object required
  - answered object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - end string (date-time) required
  - handledShare null | number required
  - handledWithoutHr object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - questions object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - start string (date-time) required
  - total number required
  - unknown object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - wentToHr object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
- minutesSaved null | number required
- previous object required
  - actions object required
    answers object required
    appActionsDone object required
    buddyAccepted object required
    hrRequestsSent object required
    playbookMessagesSent object required
    praiseTiedToValues object required
  - answered object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - end string (date-time) required
  - handledShare null | number required
  - handledWithoutHr object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - questions object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - start string (date-time) required
  - total number required
  - unknown object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - wentToHr object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
units object required
- answered string required
- handledWithoutHr string required
- minutesSaved string required
- questions string required
week object required
- coverage "complete" | "partial" | "unavailable" required
- current object required
  - actions object required
    answers object required
    appActionsDone object required
    buddyAccepted object required
    hrRequestsSent object required
    playbookMessagesSent object required
    praiseTiedToValues object required
  - answered object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - end string (date-time) required
  - handledShare null | number required
  - handledWithoutHr object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - questions object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - start string (date-time) required
  - total number required
  - unknown object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - wentToHr object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
- minutesSaved null | number required
- previous object required
  - actions object required
    answers object required
    appActionsDone object required
    buddyAccepted object required
    hrRequestsSent object required
    playbookMessagesSent object required
    praiseTiedToValues object required
  - answered object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - end string (date-time) required
  - handledShare null | number required
  - handledWithoutHr object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - questions object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - start string (date-time) required
  - total number required
  - unknown object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required
  - wentToHr object required
    Option 1 object optional
    status "available" required
    value number required
    Option 2 object optional
    status "suppressed" required

reports.mentorship

Mentorship over 30, 90 or 180 days against the period before: pairs started, ended early and completed, check-ins answered and met, pairs meeting and mentees waiting now; `programId` narrows it. Never goals

POST/api/v1/manage/reports/mentorship

Read
Permission reports.mentorship

const result = await shuffl.reports.mentorship({});

Request fields (2)

days 30 | 90 | 180 optional
programId string optional

Response object

current object required
- checkIns object required
  - answered number required
  - asked number required
  - finals number required
  - helped number required
  - met number required
- pairs object required
  - completed number required
  - endedEarly number required
  - started number required
end string (date-time) required
now object required
- meeting number required
- paused number required
- suggested number required
- waiting number required
previous object required
- checkIns object required
  - answered number required
  - asked number required
  - finals number required
  - helped number required
  - met number required
- pairs object required
  - completed number required
  - endedEarly number required
  - started number required
start string (date-time) required
weekly object required
- checkIns object[] required
  - answered number required
  - met number required
  - week string required
- pairs object[] required
  - pairs number required
  - week string required
window 30 | 90 | 180 required

reports.needsYou

Read HR request and Knowledge draft insights

POST/api/v1/manage/reports/needsYou

Read
Permission reports.needsYou

const result = await shuffl.reports.needsYou({});

Request fields (1)

days 30 | 90 | 180 optional

Response object

categories object[] required
- answeredByArticle number required
- due number required
- firstReplySeconds null | number required
- id null | string required
- name null | string required
- needsArticle number required
- received number required
- replied number required
- withinTarget number required
drafts object required
- approved number required
- pending number required
- rejected number required
end string (date-time) required
months object[] required
- answeredByArticle number required
- due number required
- firstReplySeconds null | number required
- month string required
- needsArticle number required
- received number required
- replied number required
- withinTarget number required
requests object required
- firstReplySeconds null | number required
- previous number required
- received number required
- replied number required
- resolved number required
- resolveSeconds null | number required
- stale number required
- waiting number required
start string (date-time) required
target object required
- answeredByArticle number required
- days number required
- due number required
- firstReplySeconds null | number required
- needsArticle number required
- received number required
- replied number required
- withinTarget number required
weekly object[] required
- requests number required
- week string required
window 30 | 90 | 180 required

reports.overview

Read the workspace overview figures

POST/api/v1/manage/reports/overview

Read
Permission reports.overview

const result = await shuffl.reports.overview();

Request fields (none)

This operation takes no input.

Response object

capabilities object required
- manageTeam boolean required
- respondToHr boolean required
- reviewKnowledge boolean required
internal boolean required
local boolean required
participants number optional
photoUrl null | string required
programs object[] required
- audience object required
  - eligible number required
  - exclusions object[] required
    count number required
    reason "absent" | "access_unavailable" | "bot" | "inactive" | "paused" | "slack_unavailable" required
  - paused number required
  - programId string required
  - total number required
- awaitingHandover boolean required
- channelId string required
- channelName string required
- communityIds string[] required
- communityNames string[] required
- createdAt string (date-time) required
- groupId null | string required
- groupName null | string required
- id string required
- includeBios boolean required
- includeSchedulingLink boolean required
- intro string required
- kind "introductions" | "playbook" required
- match object required
  - fineTune object optional
    commonGround 0 | 1 | 2 required
    meetRequests boolean required
    mentionCommonGround boolean required
    reach "any" | "far" | "fof" required
  - groupSize number required
  - iterations number required
  - keepApart object optional
    relationships "department" | "know-each-other" | "reporting-line" | "team"[] required
    strict boolean required
  - maxGroupSize number required
  - strategy "cross-unit" | "group-frequency-weighted" | "group-frequency-weighted-v2" | "hosted" | "new-connections" | "random" | "unit-lottery-weighted" | "unit-weighted" | "unit-weighted-multiple-hosts-per-group" | "unit-weighted-one-host-per-group" | "within-unit" required
  - unitIds string[] optional
  - unitKind "community" | "department" | "team" optional
- matchingReviewRequired boolean required
- name string required
- nextRunAt null | string (date-time) required
- playbook null | object required
  - autoStart false | true optional
  - autoStartGroupId null | string optional
  - autoStartPaused false | true optional
  - buddy false | true optional
  - buddyFollowUpOffsetDays null | number optional
  - buddyInvitation string required
  - buddyOffsetDays number required
  - buddyTopics string[] optional
  - catchUp "bundle" | "shift" | "skip" optional
  - checkIn string required
  - checkInOffsetDays number required
  - dayZero "date" | "joined" | "last_day" | "start_date" optional
  - dayZeroDate null | string optional
  - helpCheckIn false | true optional
  - introductionOffsetDays number required
  - responderPersonId null | string required
  - sendTime string required
  - steps object[] optional
    body string required
    checkpoint "custom" | "day_30" | "day_365" | "day_60" | "day_90" optional
    formFields "bio" | "birthday" | "photo" | "preferredName" | "pronouns"[] optional
    id string required
    kind "acknowledge" | "checkpoint" | "form" | "meet" | "message" | "task" required
    meet "manager" | "person" | "skip_level" | "teammates" optional
    meetCount number optional
    notFor string[] optional
    offsetDays number required
    onlyFor string[] optional
    personId null | string required
    questions object[] optional
    recipient "buddy" | "hire" | "hr" | "manager" | "person" required
    resources object[] required
    title string required
    todos object[] required
  - timezone string required
- revision number required
- rosterSyncedAt null | string (date-time) required
- schedule object required
  - Option 1 object optional
    anchor string required
    days number[] optional
    frequency "days" | "hours" | "minutes" | "monthly-date" | "monthly-last-weekday" | "monthly-weekday" | "weeks" required
    interval number required
    timezone string required
  - Option 2 object optional
    anchor string required
    calendar object required
    frequency "legacy-monthly" required
    insufficientOptInsNotice object required
    interval 1 required
    origin "source-pending" optional
    timezone string required
    version 1 required
  - Option 3 object optional
    anchor null | string required
    calendar object required
    frequency "legacy-monthly" required
    insufficientOptInsNotice object required
    interval 1 required
    origin "operator-future-start" required
    timezone string required
    version 1 required
- status "active" | "archived" | "paused" required
- teamId string required
- upcoming string (date-time)[] required
role "admin" | "member" | "owner" required
runs object[] required
- completedAt null | string (date-time) required
- config object required
  - fineTune object optional
    commonGround 0 | 1 | 2 required
    meetRequests boolean required
    mentionCommonGround boolean required
    reach "any" | "far" | "fof" required
  - groupSize number required
  - iterations number required
  - keepApart object optional
    relationships "department" | "know-each-other" | "reporting-line" | "team"[] required
    strict boolean required
  - maxGroupSize number required
  - strategy string required
  - unitIds string[] optional
  - unitKind "community" | "department" | "team" optional
- createdAt string (date-time) required
- eligibleCount number required
- historyFinalizedAt null | string (date-time) required
- id string required
- occurrence string (date-time) required
- programId string required
- reason null | string required
- requestKey string required
- revision number required
- seed string required
- selectedCount number required
- status "canceled" | "completed" | "delivering" | "needs_review" | "partial" | "planned" | "queued" | "skipped" required
- teamId string required
- workflowId null | string required
team null | object required
- id string required
- name string required
- organizationId string required
- policy object required
  - maxParticipants null | number required
  - maxPrograms null | number required
  - name "community" | "grandfathered" | "per-seat" | "pro" required
  - version string required
- slackTeamId null | string required
- status "active" | "archived" | "paused" | "uninstalled" required
userId string required
userName string required
you null | object required
- personId string required
- programs object[] required
  - optedIn boolean required
  - present boolean required
  - programId string required
  - reason null | "absent" | "access_unavailable" | "bot" | "inactive" | "paused" | "slack_unavailable" required

reports.people

Read People insights: headcount, teams and growth

POST/api/v1/manage/reports/people

Read
Permission reports.people

const result = await shuffl.reports.people({});

Request fields (1)

days 30 | 90 | 180 optional

Response object

coverage object required
- directorySync number required
- noManager number required
- noTeam number required
- slack number required
departures object required
- current number required
- previous number required
end string (date-time) required
headcount object required
- current number required
- ended number required
- onLeave number required
- withStartDate number required
history object required
- departments object[] required
  - label string required
  - value number required
- monthly object[] required
  - headcount number required
  - joined number required
  - left number required
  - month string required
- noDepartment number required
- tenure object[] required
  - label string required
  - value number required
- undated number required
joins object required
- current number required
- previous number required
roles object required
- admin number required
- hrResponder number required
- knowledgeVerifier number required
- owner number required
start string (date-time) required
weekly object required
- departures object[] required
  - value number required
  - week string required
- joins object[] required
  - value number required
  - week string required
window 30 | 90 | 180 required

reports.playbooks

Read Onboarding insights

POST/api/v1/manage/reports/playbooks

Read
Permission reports.playbooks

const result = await shuffl.reports.playbooks({});

Request fields (2)

days 30 | 90 | 180 optional
programId string optional

Response object

The response is object.