> ## 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 Analytics Data

> Retrieve analytics properties to be included in usage tracking.

NsApiSlow threshold: 2000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-DiagnosticsAgent.json post /api/v1/Agents/Diagnostics/GetAnalyticsData
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - DiagnosticsAgent
  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/Diagnostics/GetAnalyticsData:
    post:
      tags:
        - Diagnostics_Agent
      summary: Get Analytics Data
      description: |-
        Retrieve analytics properties to be included in usage tracking.

        NsApiSlow threshold: 2000 ms.
      operationId: v1DiagnosticsAgent_GetAnalyticsData
      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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.AnalyticsData'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.AnalyticsData'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.AnalyticsData'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.AnalyticsData'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.AnalyticsData'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.AnalyticsData'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.AnalyticsData:
      description: "Carrier object for AnalyticsData.\r\nServices for the AnalyticsData Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IDiagnosticsAgent\">Diagnostics Agent</see>."
      type: object
      properties:
        Name:
          description: User full name. Only included in Sod
          type: string
        Email:
          description: User email address. Only included in Sod
          type: string
        Company:
          description: User company name. Only included in Sod
          type: string
        LicenseStatus:
          $ref: >-
            #/components/schemas/SuperOffice.CRM.Services.UserAndInstallationLicenceStatus
        HasLicensce:
          description: Dictionary of license types and their status
          type: object
          additionalProperties:
            type: boolean
        SystemLicenseNames:
          description: Names of system licenses assigned to the user
          type: array
          items:
            type: string
        UserSignedUpAt:
          description: Date and time when the user signed up
          type: string
        NumContact:
          format: int32
          description: Number of contacts associated with the user
          type: integer
        NumPerson:
          format: int32
          description: Number of persons associated with the user
          type: integer
        NumAppointment:
          format: int32
          description: Number of appointments for the user
          type: integer
        NumSale:
          format: int32
          description: Number of sales associated with the user
          type: integer
        NumProject:
          format: int32
          description: Number of projects associated with the user
          type: integer
        NumSelection:
          format: int32
          description: Number of selections made by the user
          type: integer
        NumEmailItem:
          format: int32
          description: Number of email items associated with the user
          type: integer
        NumTicketLogAction:
          format: int32
          description: Number of ticket log actions performed by the user
          type: integer
        NumDashboard:
          format: int32
          description: Number of dashboards available to the user
          type: integer
        NumQuote:
          format: int32
          description: Number of quotes created by the user
          type: integer
        NumQuoteLine:
          format: int32
          description: Number of quote lines associated with the user
          type: integer
        NumDocument:
          format: int32
          description: Number of documents associated with the user
          type: integer
        NumTargetAssignmentInfo:
          format: int32
          description: Number of target assignment info records
          type: integer
        NumMailing:
          format: int32
          description: Number of mailings sent by the user
          type: integer
        NumForm:
          format: int32
          description: Number of forms created by the user
          type: integer
        NumWorkflow:
          format: int32
          description: Number of workflows associated with the user
          type: integer
        TotContact:
          format: int32
          description: Total number of contacts in the system
          type: integer
        TotPerson:
          format: int32
          description: Total number of persons in the system
          type: integer
        TotAppointment:
          format: int32
          description: Total number of appointments in the system
          type: integer
        TotSale:
          format: int32
          description: Total number of sales in the system
          type: integer
        TotProject:
          format: int32
          description: Total number of projects in the system
          type: integer
        TotSelection:
          format: int32
          description: Total number of selections in the system
          type: integer
        TotEmailItem:
          format: int32
          description: Total number of email items in the system
          type: integer
        TotTicketLogAction:
          format: int32
          description: Total number of ticket log actions in the system
          type: integer
        TotDashboard:
          format: int32
          description: Total number of dashboards in the system
          type: integer
        TotQuote:
          format: int32
          description: Total number of quotes in the system
          type: integer
        TotQuoteLine:
          format: int32
          description: Total number of quote lines in the system
          type: integer
        TotDocument:
          format: int32
          description: Total number of documents in the system
          type: integer
        TotTargetAssignmentInfo:
          format: int32
          description: Total number of target assignment info records
          type: integer
        TotMailing:
          format: int32
          description: Total number of mailings in the system
          type: integer
        TotForm:
          format: int32
          description: Total number of forms in the system
          type: integer
        TotWorkflow:
          format: int32
          description: Total number of workflows in the system
          type: integer
        UserRegisteredAgeDays:
          format: int32
          description: Number of days since the user registered
          type: integer
        UserCountryName:
          description: Name of the user's country
          type: string
        UserCountryCode:
          description: Country code of the user
          type: string
        Preferences:
          description: Array of user preferences (name and value)
          type: object
          additionalProperties:
            type: boolean
        TotWebUsers:
          format: int32
          description: Total number of web users in the system
          type: integer
        GroupCountryName:
          description: Name of the group's country
          type: string
        GroupCountryCode:
          description: Country code of the group
          type: string
        GroupRegisteredDate:
          description: Date when the group was registered
          type: string
        GroupRegisteredAgeDays:
          format: int32
          description: Number of days since the group was registered
          type: integer
        FeatureToggles:
          description: Array of feature toggles (name and enabled status)
          type: object
          additionalProperties:
            type: boolean
        FileVersion:
          description: Current file version as a string
          type: string
        FileVersionNumber:
          format: int32
          description: Current file version as a number
          type: integer
    SuperOffice.CRM.Services.UserAndInstallationLicenceStatus:
      description: "Result of GetUserAndInstallationLicenceStatus\r\n<para />\r\nCarrier object for UserAndInstallationLicenceStatus.\r\nServices for the UserAndInstallationLicenceStatus Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.ILicenseAgent\">License Agent</see>."
      type: object
      properties:
        AdminWarningDate:
          format: date-time
          description: Installations license admin warning date
          type: string
        ExpiryDate:
          format: date-time
          description: Installations license expiry date
          type: string
        GraceDate:
          format: date-time
          description: Installations license grace date
          type: string
        CompanyName:
          description: Database company name
          type: string
        SerialNr:
          description: Database serial number
          type: string
        UserLicenses:
          description: The users module licenses names
          type: array
          items:
            type: string

````

## Related topics

- [SuperOffice.WebApi.Data.Diagnostics GetAnalyticsDataRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Diagnostics_GetAnalyticsDataRequest.md)
- [SuperOffice.WebApi.Agents.DiagnosticsAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DiagnosticsAgent.md)
- [SuperOffice.WebApi.Agents.IDiagnosticsAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IDiagnosticsAgent.md)
- [SuperOffice.WebApi.Data.AnalyticsData](/en/api/reference/webapi/SuperOffice.WebApi.Data.AnalyticsData.md)
- [NSEmailFlow](/en/automation/crmscript/reference/CRMScript.NetServer.NSEmailFlow.md)
- [Tutorial - simple Google Analytics email tracking](/en/marketing/tracked-links/learn/ga-tutorial.md)