--- title: "Retrieve items used for dashboards and analytics" method: POST path: "/api/workspaces/{workspaceId}/items/analytics" tags: ["Items"] --- # Retrieve items used for dashboards and analytics `POST /api/workspaces/{workspaceId}/items/analytics` ## Request - Base URL: `https://app.airfocus.com` - URL: `https://app.airfocus.com/api/workspaces/{workspaceId}/items/analytics` - Auth: HTTP bearer Returns items in the requested shape. The responses has 1-1 mapping with requests for batching purposes.
Requirements:
- auth-client scopes: "workspace:read"
- user permission: "read" or higher ## Path parameters - `workspaceId` string, uuid, required ## Query parameters - `actAsAdmin` boolean ## Request body - GetItemsAnalyticsRequest[] - union - GetItemsAnalyticsRequestBreakdown - `breakdown` GetItemsAnalyticsRequestBreakdownConfigurableProperty, required - `property` union, required: Item property - GetItemsAnalyticsRequestPropertyCompletionDate - `type` 'completionDate', required - GetItemsAnalyticsRequestPropertyCompletionTime - `type` 'completionTime', required - GetItemsAnalyticsRequestPropertyFieldType - `fieldType` 'insights' | 'prioritization' | 'health-check-ins-field' | 'votingScore', required - `type` 'fieldType', required - GetItemsAnalyticsRequestPropertyItemRef - `ref` union, required - … - `type` 'itemRef', required - GetItemsAnalyticsRequestPropertyKeyResult - `type` 'keyResult', required - GetItemsAnalyticsRequestPropertyObjective - `type` 'objective', required - GetItemsAnalyticsRequestPropertyStatusCategory - `type` 'statusCategory', required - `setting` union: Specific bucket setting used for breakdown - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingAuto - `type` 'grouping:auto', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingBucketCount - `count` integer, required - `type` 'grouping:bucketCount', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingInterval - `interval` number, required - `type` 'grouping:interval', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodDaily - `type` 'period:daily', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodMonthly - `type` 'period:monthly', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodQuarterly - `type` 'period:quarterly', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodWeekly - `type` 'period:weekly', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodYearly - `type` 'period:yearly', required - `includeArchived` boolean: Includes archived items or not, default: false - `itemFilter` union - ItemSearchQueryFilterAliasContain - `caseSensitive` boolean, required - `text` string, required - `type` 'alias:contain', required - ItemSearchQueryFilterAnd - `inner` ItemSearchQueryFilter[], required - `type` 'and', required - ItemSearchQueryFilterArchivedValue - `type` 'archived:value', required - `value` boolean, required - ItemSearchQueryFilterAssigneesContain - `type` 'assignees:contain', required - `user` union, required - UserRefUserGroupRefId - … - UserRefUserRefCurrent - … - UserRefUserRefId - … - ItemSearchQueryFilterAssigneesContainsAll - `type` 'assignees:containsAll', required - `users` UserRef[], required - union - … - ItemSearchQueryFilterAssigneesContainsAny - `type` 'assignees:containsAny', required - `users` UserRef[], required - union - … - ItemSearchQueryFilterAssigneesDefined - `type` 'assignees:defined', required - ItemSearchQueryFilterCompletionTimeBetween - `end` integer, required: end range in days - `start` integer, required: start range in days - `type` 'completionTime:between', required - ItemSearchQueryFilterCreatedAtAbsolute - `mode` 'after' | 'afterOrOn' | 'before' | 'beforeOrOn', required - `type` 'createdAt:absolute', required - `value` ItemSearchQueryDateTimeFilterValue, required - `date` string, date, required - `time` string - `zoneId` string, required - ItemSearchQueryFilterCreatedAtRange - `from` string, date, required - `type` 'createdAt:range', required - `until` string, date, required - ItemSearchQueryFilterCreatedAtRelative - `anchor` union, required - ItemSearchQueryTimeAnchorDays - … - ItemSearchQueryTimeAnchorMonths - … - ItemSearchQueryTimeAnchorWeeks - … - `type` 'createdAt:relative', required - ItemSearchQueryFilterDescriptionContain - `caseSensitive` boolean, required - `text` string, required - `type` 'description:contain', required - ItemSearchQueryFilterDescriptionDefined - `type` 'description:defined', required - ItemSearchQueryFilterFieldType - `fieldType` string, required - `filter` union, required - union - … - union - … - union - … - union - … - FormsTargetFieldTypeFilter - … - union - … - union - … - union - … - MirrorSourceFieldTypeFilter - … - MirrorTargetFieldTypeFilter - … - union - … - union - … - union - … - OkrKeyResultsFieldFilter - … - union - … - union - … - PortfolioSourceFieldFilter - … - union - … - union - … - union - … - union - … - union - … - `type` 'field:type', required - ItemSearchQueryFilterFieldValue - `fieldId` string, uuid, required - `filter` union, required - union - … - union - … - union - … - union - … - FormsTargetFieldTypeFilter - … - union - … - union - … - union - … - MirrorSourceFieldTypeFilter - … - MirrorTargetFieldTypeFilter - … - union - … - union - … - union - … - OkrKeyResultsFieldFilter - … - union - … - union - … - PortfolioSourceFieldFilter - … - union - … - union - … - union - … - union - … - union - … - `type` 'field:value', required - ItemSearchQueryFilterIdAny - `type` 'id:any', required - `values` string[], required - ItemSearchQueryFilterIntegrationDefined - `type` 'integration:defined', required - ItemSearchQueryFilterIntegrationValue - `integrationId` string, uuid, required - `type` 'integration:value', required - ItemSearchQueryFilterItemWatchSelf - `type` 'item:watchSelf', required - ItemSearchQueryFilterLastUpdatedAtAbsolute - `mode` 'after' | 'afterOrOn' | 'before' | 'beforeOrOn', required - `property` union - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace' - string: A combination of 'fieldid:' prefix and a UUID field-id. - `type` 'lastUpdatedAt:absolute', required - `value` ItemSearchQueryDateTimeFilterValue, required - `date` string, date, required - `time` string - `zoneId` string, required - ItemSearchQueryFilterLastUpdatedAtRange - `from` string, date, required - `property` union - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace' - string: A combination of 'fieldid:' prefix and a UUID field-id. - `type` 'lastUpdatedAt:range', required - `until` string, date, required - ItemSearchQueryFilterLastUpdatedAtRelative - `anchor` union, required - ItemSearchQueryTimeAnchorDays - … - ItemSearchQueryTimeAnchorMonths - … - ItemSearchQueryTimeAnchorWeeks - … - `property` union - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace' - string: A combination of 'fieldid:' prefix and a UUID field-id. - `type` 'lastUpdatedAt:relative', required - ItemSearchQueryFilterNameContain - `caseSensitive` boolean, required - `text` string, required - `type` 'name:contain', required - ItemSearchQueryFilterNameEqual - `caseSensitive` boolean, required - `text` string, required - `type` 'name:equal', required - ItemSearchQueryFilterNot - `inner` ItemSearchQueryFilter, required (recursive) - `type` 'not', required - ItemSearchQueryFilterOr - `inner` ItemSearchQueryFilter[], required - `type` 'or', required - ItemSearchQueryFilterParentDefined - `type` 'parent:defined', required - ItemSearchQueryFilterParentValue - `itemId` string, uuid, required - `type` 'parent:value', required - `workspaceId` string, uuid, required - ItemSearchQueryFilterStatusCategoryContainsAny - `categories` StatusCategory[], required - `type` 'statusCategory:containsAny', required - ItemSearchQueryFilterStatusCategoryUpdatedBetween - `end` string, date, required - `start` string, date, required - `type` 'statusCategory:updatedBetween', required - ItemSearchQueryFilterStatusCategoryUpdatedSince - `type` 'statusCategory:updatedSince', required - `value` union, required - ItemSearchQueryTimeAnchorDays - … - ItemSearchQueryTimeAnchorMonths - … - ItemSearchQueryTimeAnchorWeeks - … - ItemSearchQueryFilterStatusContainsAny - `statusIds` string[], required - `type` 'status:containsAny', required - ItemSearchQueryFilterStatusUpdatedSince - `type` 'status:updatedSince', required - `value` union, required - ItemSearchQueryTimeAnchorDays - … - ItemSearchQueryTimeAnchorMonths - … - ItemSearchQueryTimeAnchorWeeks - … - ItemSearchQueryFilterUpdatedSince - `property` union - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace' - string: A combination of 'fieldid:' prefix and a UUID field-id. - `timestamp` string, date-time, required - `type` 'updated:since', required - ItemSearchQueryFilterWorkspaceContains - `id` string, uuid, required - `type` 'workspace:contains', required - ItemSearchQueryFilterWorkspaceContainsAny - `type` 'workspace:containsAny', required - `workspaceIds` string[], required - `segment` GetItemsAnalyticsRequestBreakdownConfigurableProperty - `property` union, required: Item property - GetItemsAnalyticsRequestPropertyCompletionDate - `type` 'completionDate', required - GetItemsAnalyticsRequestPropertyCompletionTime - `type` 'completionTime', required - GetItemsAnalyticsRequestPropertyFieldType - `fieldType` 'insights' | 'prioritization' | 'health-check-ins-field' | 'votingScore', required - `type` 'fieldType', required - GetItemsAnalyticsRequestPropertyItemRef - `ref` union, required - … - `type` 'itemRef', required - GetItemsAnalyticsRequestPropertyKeyResult - `type` 'keyResult', required - GetItemsAnalyticsRequestPropertyObjective - `type` 'objective', required - GetItemsAnalyticsRequestPropertyStatusCategory - `type` 'statusCategory', required - `setting` union: Specific bucket setting used for breakdown - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingAuto - `type` 'grouping:auto', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingBucketCount - `count` integer, required - `type` 'grouping:bucketCount', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingInterval - `interval` number, required - `type` 'grouping:interval', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodDaily - `type` 'period:daily', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodMonthly - `type` 'period:monthly', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodQuarterly - `type` 'period:quarterly', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodWeekly - `type` 'period:weekly', required - GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodYearly - `type` 'period:yearly', required - `type` 'breakdown', required - GetItemsAnalyticsRequestNumber - `includeArchived` boolean: Includes archived items or not, default: false - `itemFilter` union - ItemSearchQueryFilterAliasContain - `caseSensitive` boolean, required - `text` string, required - `type` 'alias:contain', required - ItemSearchQueryFilterAnd - `inner` ItemSearchQueryFilter[], required - `type` 'and', required - ItemSearchQueryFilterArchivedValue - `type` 'archived:value', required - `value` boolean, required - ItemSearchQueryFilterAssigneesContain - `type` 'assignees:contain', required - `user` union, required - UserRefUserGroupRefId - … - UserRefUserRefCurrent - … - UserRefUserRefId - … - ItemSearchQueryFilterAssigneesContainsAll - `type` 'assignees:containsAll', required - `users` UserRef[], required - union - … - ItemSearchQueryFilterAssigneesContainsAny - `type` 'assignees:containsAny', required - `users` UserRef[], required - union - … - ItemSearchQueryFilterAssigneesDefined - `type` 'assignees:defined', required - ItemSearchQueryFilterCompletionTimeBetween - `end` integer, required: end range in days - `start` integer, required: start range in days - `type` 'completionTime:between', required - ItemSearchQueryFilterCreatedAtAbsolute - `mode` 'after' | 'afterOrOn' | 'before' | 'beforeOrOn', required - `type` 'createdAt:absolute', required - `value` ItemSearchQueryDateTimeFilterValue, required - `date` string, date, required - `time` string - `zoneId` string, required - ItemSearchQueryFilterCreatedAtRange - `from` string, date, required - `type` 'createdAt:range', required - `until` string, date, required - ItemSearchQueryFilterCreatedAtRelative - `anchor` union, required - ItemSearchQueryTimeAnchorDays - … - ItemSearchQueryTimeAnchorMonths - … - ItemSearchQueryTimeAnchorWeeks - … - `type` 'createdAt:relative', required - ItemSearchQueryFilterDescriptionContain - `caseSensitive` boolean, required - `text` string, required - `type` 'description:contain', required - ItemSearchQueryFilterDescriptionDefined - `type` 'description:defined', required - ItemSearchQueryFilterFieldType - `fieldType` string, required - `filter` union, required - union - … - union - … - union - … - union - … - FormsTargetFieldTypeFilter - … - union - … - union - … - union - … - MirrorSourceFieldTypeFilter - … - MirrorTargetFieldTypeFilter - … - union - … - union - … - union - … - OkrKeyResultsFieldFilter - … - union - … - union - … - PortfolioSourceFieldFilter - … - union - … - union - … - union - … - union - … - union - … - `type` 'field:type', required - ItemSearchQueryFilterFieldValue - `fieldId` string, uuid, required - `filter` union, required - union - … - union - … - union - … - union - … - FormsTargetFieldTypeFilter - … - union - … - union - … - union - … - MirrorSourceFieldTypeFilter - … - MirrorTargetFieldTypeFilter - … - union - … - union - … - union - … - OkrKeyResultsFieldFilter - … - union - … - union - … - PortfolioSourceFieldFilter - … - union - … - union - … - union - … - union - … - union - … - `type` 'field:value', required - ItemSearchQueryFilterIdAny - `type` 'id:any', required - `values` string[], required - ItemSearchQueryFilterIntegrationDefined - `type` 'integration:defined', required - ItemSearchQueryFilterIntegrationValue - `integrationId` string, uuid, required - `type` 'integration:value', required - ItemSearchQueryFilterItemWatchSelf - `type` 'item:watchSelf', required - ItemSearchQueryFilterLastUpdatedAtAbsolute - `mode` 'after' | 'afterOrOn' | 'before' | 'beforeOrOn', required - `property` union - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace' - string: A combination of 'fieldid:' prefix and a UUID field-id. - `type` 'lastUpdatedAt:absolute', required - `value` ItemSearchQueryDateTimeFilterValue, required - `date` string, date, required - `time` string - `zoneId` string, required - ItemSearchQueryFilterLastUpdatedAtRange - `from` string, date, required - `property` union - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace' - string: A combination of 'fieldid:' prefix and a UUID field-id. - `type` 'lastUpdatedAt:range', required - `until` string, date, required - ItemSearchQueryFilterLastUpdatedAtRelative - `anchor` union, required - ItemSearchQueryTimeAnchorDays - … - ItemSearchQueryTimeAnchorMonths - … - ItemSearchQueryTimeAnchorWeeks - … - `property` union - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace' - string: A combination of 'fieldid:' prefix and a UUID field-id. - `type` 'lastUpdatedAt:relative', required - ItemSearchQueryFilterNameContain - `caseSensitive` boolean, required - `text` string, required - `type` 'name:contain', required - ItemSearchQueryFilterNameEqual - `caseSensitive` boolean, required - `text` string, required - `type` 'name:equal', required - ItemSearchQueryFilterNot - `inner` ItemSearchQueryFilter, required (recursive) - `type` 'not', required - ItemSearchQueryFilterOr - `inner` ItemSearchQueryFilter[], required - `type` 'or', required - ItemSearchQueryFilterParentDefined - `type` 'parent:defined', required - ItemSearchQueryFilterParentValue - `itemId` string, uuid, required - `type` 'parent:value', required - `workspaceId` string, uuid, required - ItemSearchQueryFilterStatusCategoryContainsAny - `categories` StatusCategory[], required - `type` 'statusCategory:containsAny', required - ItemSearchQueryFilterStatusCategoryUpdatedBetween - `end` string, date, required - `start` string, date, required - `type` 'statusCategory:updatedBetween', required - ItemSearchQueryFilterStatusCategoryUpdatedSince - `type` 'statusCategory:updatedSince', required - `value` union, required - ItemSearchQueryTimeAnchorDays - … - ItemSearchQueryTimeAnchorMonths - … - ItemSearchQueryTimeAnchorWeeks - … - ItemSearchQueryFilterStatusContainsAny - `statusIds` string[], required - `type` 'status:containsAny', required - ItemSearchQueryFilterStatusUpdatedSince - `type` 'status:updatedSince', required - `value` union, required - ItemSearchQueryTimeAnchorDays - … - ItemSearchQueryTimeAnchorMonths - … - ItemSearchQueryTimeAnchorWeeks - … - ItemSearchQueryFilterUpdatedSince - `property` union - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace' - string: A combination of 'fieldid:' prefix and a UUID field-id. - `timestamp` string, date-time, required - `type` 'updated:since', required - ItemSearchQueryFilterWorkspaceContains - `id` string, uuid, required - `type` 'workspace:contains', required - ItemSearchQueryFilterWorkspaceContainsAny - `type` 'workspace:containsAny', required - `workspaceIds` string[], required - `type` 'number', required ## Response `200` - GetItemsAnalyticsResponse[] - union - GetItemsAnalyticsResponseBreakdown - `breakdown` GetItemsAnalyticsResponseBreakdownBreakdownBucket[], required: Buckets with items - `count` integer, required - `id` string, uuid, required - `segments` GetItemsAnalyticsResponseBreakdownSegmentBucket[], required - `count` integer, required - `id` string, uuid, required - `buckets` object, required: Buckets descriptions - `itemCount` integer, required: Count of unique items in the breakdowns - `type` 'breakdown', required - GetItemsAnalyticsResponseError - `reason` string, required - `type` 'error', required - GetItemsAnalyticsResponseNumber - `itemCount` integer, required: Count of unique items - `type` 'number', required ## Other responses - `400`: If path parameters are invalid or payload is invalid or resource does not exist. - `401`: If missing authentication token. - `403`: If user does not have the required permission, or authenticated client does not have the required access scopes. - `default`: If any other error happens. --- [API](https://skmtc.dev/airfocus/apis/airfocus-api.md) · [All operations](https://skmtc.dev/airfocus/apis/airfocus-api/llms.txt) · [OpenAPI document](https://skmtc.dev/airfocus/apis/airfocus-api/revisions/fc9ccaa2ec6d?raw)