> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Summary By Group > NsApiSlow threshold: 3000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-SaleAgent.json post /api/v1/Agents/Sale/GetSummaryByGroup openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - SaleAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/Sale/GetSummaryByGroup: post: tags: - Sale_Agent summary: Get Summary By Group description: 'NsApiSlow threshold: 3000 ms.' operationId: v1SaleAgent_GetSummaryByGroup parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.GetSummaryByGroupRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.GetSummaryByGroupRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.GetSummaryByGroupRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.GetSummaryByGroupRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.GetSummaryByGroupRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.GetSummaryByGroupRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.GetSummaryByGroupRequest description: GroupId, FromDate, ToDate required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.SaleSummary' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.SaleSummary' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.SaleSummary' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.SaleSummary' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.SaleSummary' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.SaleSummary' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.SaleCarriers.GetSummaryByGroupRequest: description: 'GetSummaryByGroup:' type: object properties: GroupId: format: int32 type: integer FromDate: format: date-time type: string ToDate: format: date-time type: string SuperOffice.CRM.Services.SaleSummary: description: "Carrier object for SaleSummary.\r\nServices for the SaleSummary Carrier is available from the Sale Agent." type: object properties: BaseCurrency: description: Default currency for the installation type: string OwnCurrency: description: Default currency for the current user type: string SoldTotalBaseCurrency: format: double description: >- Summed amount for all sold within the period in default currency for the installation type: number Sold: format: int32 description: Number of all sold within the period type: integer SoldTotalOwnCurrency: format: double description: >- Summed amount for all sold within the period in default currency for the current user type: number Lost: format: int32 description: Number of all lost within the period type: integer LostTotalBaseCurrency: format: double description: >- Summed amount for all lost within the period in default currency for the installation type: number LostTotalOwnCurrency: format: double description: >- Summed amount for all lost within the period in default currency for the current user type: number Open: format: int32 description: Number of all open within the period type: integer OpenTotalBaseCurrency: format: double description: >- Summed amount for all open within the period in default currency for the installation type: number OpenTotalOwnCurrency: format: double description: >- Summed amount for all open within the period in default currency for the current user type: number OpenWeightedBaseCurrency: format: double description: >- Weighted sum for all open within the period in default currency for the installation type: number OpenWeightedOwnCurrency: format: double description: >- Weighted sum for all open within the period in default currency for the current user type: number PreviousOverdue: format: int32 description: Number of all open sales with date before this period type: integer PreviousOverdueTotalBaseCurrency: format: double description: >- Summed amount for all open sales with date before this period in default currency for the installation type: number PreviousOverdueTotalOwnCurrency: format: double description: >- Summed amount for all open sales with date before this period in default currency for the current user type: number PreviousOverdueWeightedBaseCurrency: format: double description: >- Weighted sum for all open sales with date before this period in default currency for the installation type: number PreviousOverdueWeightedOwnCurrency: format: double description: >- Weighted sum for all open sales with date before this period in default currency for the current user type: number CurrentOverdue: format: int32 description: Number of all overdue sales within the period type: integer CurrentOverdueTotalBaseCurrency: format: double description: >- Summed amount for all overdue sales within the period in default currency for the installation type: number CurrentOverdueTotalOwnCurrency: format: double description: >- Summed amount for all overdue sales within the period in default currency for the current user type: number CurrentOverdueWeightedBaseCurrency: format: double description: >- Weighted sum for all overdue sales within the period in default currency for the installation type: number CurrentOverdueWeightedOwnCurrency: format: double description: >- Weighted sum for all overdue sales within the period in default currency for the current user type: number FutureOpen: format: int32 description: Number of all Future Pipe/All open sales with date after the period type: integer FutureOpenTotalBaseCurrency: format: double description: >- Summed amount for all Future Pipe/All open sales with date after the period in default currency for the installation type: number FutureOpenTotalOwnCurrency: format: double description: >- Summed amount for all Future Pipe/All open sales with date after the period in default currency for the current user type: number FutureOpenWeightedBaseCurrency: format: double description: >- Weighted sum for all Future Pipe/All open sales with date after the period in default currency for the installation type: number FutureOpenWeightedOwnCurrency: format: double description: >- Weighted sum for all Future Pipe/All open sales with date after the period in default currency for the current user type: number TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [SuperOffice.WebApi.Data.Sale GetSummaryByGroupRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Sale_GetSummaryByGroupRequest.md) - [NSSaleAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSSaleAgent.md) - [Get Group Associate Ids](/en/api/reference/restful/agent/archive_agent/get-group-associate-ids.md) - [Get Target Group Ids](/en/api/reference/restful/agent/targets_agent/get-target-group-ids.md) - [Get User Group](/en/api/reference/restful/rest/list_usergroup/get-user-group.md)