--- title: "GET /finance/analytics/sales/overview" method: GET path: "/finance/analytics/sales/overview" tags: ["finance"] --- # GET /finance/analytics/sales/overview `GET /finance/analytics/sales/overview` ## Query parameters - `options.fromDate` string, date-time - `options.toDate` string, date-time - `options.distributors` integer[] - `options.countryCodes` string[] - `options.countryIds` integer[] - `options.countryId` integer - `options.readyOnly` boolean - `options.artistId` integer - `options.artistIds` integer[] - `options.releaseId` integer - `options.releaseIds` integer[] - `options.trackId` integer - `options.trackIds` integer[] - `options.payeeId` integer - `options.labelId` integer - `options.labelIds` integer[] - `options.userStatementQueueId` integer - `options.storeId` integer - `options.storeIds` integer[] - `options.serviceIds` integer[] - `options.saleItemTypeId` integer - `options.statementDisplayTypeId` 'ExternalTrends' | 'ExternalDistribution' | 'InternalDistribution' | 'Mechanicals' | 'Royalty' - `options.id` string - `options.excludeIds` string[] - `options.excludeCountryId` integer - `options.groupBy` 'Label' | 'Artist' | 'Release' | 'Track' | 'DeliveryType' | 'DeliveryTypeGroup' | 'Service' | 'Country' | 'ItemType' | 'Date' | 'DateMonthly' | 'DateYearly' | 'DateDaily' | 'DateMonth' | 'Payee' | 'Total' | 'StatementDisplayType' | 'Store' | 'City' | 'Region' | 'Playlist' - `options.subGroupBy` 'Label' | 'Artist' | 'Release' | 'Track' | 'DeliveryType' | 'DeliveryTypeGroup' | 'Service' | 'Country' | 'ItemType' | 'Date' | 'DateMonthly' | 'DateYearly' | 'DateDaily' | 'DateMonth' | 'Payee' | 'Total' | 'StatementDisplayType' | 'Store' | 'City' | 'Region' | 'Playlist' - `options.subGroupPageSize` integer - `options.received` boolean - `options.excludeResult` boolean - `options.deliveryTypeIds` integer[] - `options.deliveryTypeGroups` string[] - `options.cityId` integer - `options.cityIds` integer[] - `options.regionId` integer - `options.regionIds` integer[] - `options.playlistId` integer - `options.playlistIds` integer[] - `options.selectAll` boolean - `options.partOfPlaylist` boolean - `options.yProperty` 'TotalNet' | 'TotalQuantity' - `options.withDelta` boolean - `options.processed` boolean - `options.payeeStatus` 'Blocked' | 'Unblocked' - `options.payeeType` 'VIP' | 'Standard' - `options.statementDeliveredType` 'EmailSent' | 'EmailNotSent' - `options.approved` boolean - `options.userStatementId` integer - `options.contractId` integer - `options.totalNetFilter` 'EqualTo' | 'GreaterThan' | 'LessThan' - `options.totalNet` number, double - `options.isRoyaltyTokenPayee` boolean - `options.isCrypto` boolean - `options.getBalanceItemStatements` boolean - `options.pageNumber` integer - `options.pageSize` integer - `options.orderByProperty` string - `options.orderByDescending` boolean - `options.searchText` string ## Response `200` OK - object - `label` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `artist` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `release` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `track` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `deliveryType` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `service` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `country` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `itemType` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `date` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `payee` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `total` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `statementDisplayType` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `store` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `city` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `region` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `playlist` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `deliveryTypeGroup` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `dateMonthly` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `dateYearly` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `dateDaily` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object - `dateMonth` PagedListWithTotalSaleReportGroupedItemDTO - `total` number, double - `totalItemsCount` integer - `pageNumber` integer - `pageSize` integer - `items` SaleReportGroupedItemDTO[] - `totalQuantity` integer - `totalNet` number, double - `name` string - `id` string - `complementaryInfo` object - `catalog` string - `artistName` string - `labelName` string - `previousPeriodTotalQuantity` number, double - `previousPeriodTotalNet` number, double - `deltaPercentage` number, double - `percentage` number, double - `imageId` string - `subItems` PagedListWithTotalSaleReportGroupedItemDTO — recursive - `additionalCounters` object --- [API](https://skmtc.net/revelator/apis/revelator-api.md) · [All operations](https://skmtc.net/revelator/apis/revelator-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/revelator/revelator-api/revisions/9bb4b5cb4dc2/schema)