> ## 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 Recipient Statistics From Contact Person Ids

> Returns a RecipientStatistics object with a count of addresses, emailaddresses and emailaddresses based on contact and persons in a collection of ContactPersonId.

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-SelectionAgent.json post /api/v1/Agents/Selection/GetRecipientStatisticsFromContactPersonIds
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - SelectionAgent
  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/Selection/GetRecipientStatisticsFromContactPersonIds:
    post:
      tags:
        - Selection_Agent
      summary: Get Recipient Statistics From Contact Person Ids
      description: >-
        Returns a RecipientStatistics object with a count of addresses,
        emailaddresses and emailaddresses based on contact and persons in a
        collection of ContactPersonId.


        NsApiSlow threshold: 5000 ms.
      operationId: v1SelectionAgent_GetRecipientStatisticsFromContactPersonIds
      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.SelectionCarriers.GetRecipientStatisticsFromContactPersonIdsRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetRecipientStatisticsFromContactPersonIdsRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetRecipientStatisticsFromContactPersonIdsRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetRecipientStatisticsFromContactPersonIdsRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetRecipientStatisticsFromContactPersonIdsRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetRecipientStatisticsFromContactPersonIdsRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetRecipientStatisticsFromContactPersonIdsRequest
        description: ContactPersonIds
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.RecipientStatistics
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.RecipientStatistics
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.RecipientStatistics
            text/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.RecipientStatistics
            application/json-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.RecipientStatistics
            application/merge-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.RecipientStatistics
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetRecipientStatisticsFromContactPersonIdsRequest:
      description: >-
        GetRecipientStatisticsFromContactPersonIds: Returns a
        RecipientStatistics object with a count of addresses, emailaddresses and
        emailaddresses based on contact and persons in a collection of
        ContactPersonId.
      type: object
      properties:
        ContactPersonIds:
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactPersonId'
    SuperOffice.CRM.Services.RecipientStatistics:
      description: "Class representing a RecipientStatistics carrier used for counting attributes on selection members.\r\n<para />\r\nCarrier object for RecipientStatistics."
      type: object
      properties:
        Total:
          format: int32
          description: Total number of members.
          type: integer
        ValidPostalAddresses:
          format: int32
          description: Number of members with a valid postal address.
          type: integer
        ValidEmailAddresses:
          format: int32
          description: Number of members with a valid email address.
          type: integer
        ValidFaxNumbers:
          format: int32
          description: Number of members with a valid fax number.
          type: integer
        NoAddresses:
          format: int32
          description: Number of members with an invalid address.
          type: integer
        NoFaxOrEmails:
          format: int32
          description: Number of members with no fax or email address.
          type: integer
        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.Services.ContactPersonId:
      description: "Class representing an ContactPersonId carrier used for storing either a person id or a contact id. If PersonId contains an id, ContactId will be 0, and the other way around.\r\n<para />\r\nCarrier object for ContactPersonId."
      type: object
      properties:
        PersonId:
          format: int32
          description: A person id.
          type: integer
        ContactId:
          format: int32
          description: A contact id.
          type: integer
        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.Selection GetRecipientStatisticsFromContactPersonIdsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Selection_GetRecipientStatisticsFromContactPersonIdsRequest.md)
- [NSSelectionAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSSelectionAgent.md)
- [SuperOffice.WebApi.Agents.ISelectionAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ISelectionAgent.md)
- [SuperOffice.WebApi.Agents.SelectionAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.SelectionAgent.md)
- [Get Recipient Statistics](/en/api/reference/restful/agent/selection_agent/get-recipient-statistics.md)
- [NSRecipientStatistics](/en/automation/crmscript/reference/CRMScript.NetServer.NSRecipientStatistics.md)