Field groups and includeDetails

Most reports return more fields than you typically need. Two query parameters control the response shape: fieldGroup chooses sets of related fields, and includeDetails opts into human-readable display fields alongside IDs.

fieldGroup

Each report has a fixed catalog of named field groups (for instance, replyData and closeData on the User Performance report), listed on the endpoint’s reference page. You opt into one or more by name:

?fieldGroup=replyData
?fieldGroup=replyData,closeData

Rules:

• If you omit fieldGroup, the endpoint’s default group is used.
• Multiple groups are comma-separated. Order doesn’t matter.
• A field that appears in multiple requested groups appears once in each result row, not duplicated.

The endpoint reference page shows every field in every group, so you can pick the smallest set that covers what you need.

includeDetails

Reports return identifiers like userId, mailboxId, and tag IDs. Set includeDetails=true to also receive human-readable names alongside.

?includeDetails=true

• Default is false — IDs only.
• Each endpoint documents its detail fields — typically display name, email, and an active flag — under the field group section.

Use includeDetails=true when you’re consuming the data directly (a dashboard, for example); leave it off when you’re caching or normalizing in your own database, where you’d join on the IDs anyway.

Example

POST /api/v1/reports/mailboxUserPerformance with both:

?fieldGroup=replyData,closeData&includeDetails=true

returns rows that include every field from replyData and closeData, plus the user’s userName, userEmail, and userActive flag.

See also

• Pagination — how to page through the rows.
• The endpoint reference pages document which groups and detail fields each report supports.