> ## 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 Web App Usages For Period > Get all WebAppUsages for a given period, that match an optional search term NsApiSlow threshold: 2000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-DiagnosticsAgent.json post /api/v1/Agents/Diagnostics/GetWebAppUsagesForPeriod 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/GetWebAppUsagesForPeriod: post: tags: - Diagnostics_Agent summary: Get Web App Usages For Period description: >- Get all WebAppUsages for a given period, that match an optional search term NsApiSlow threshold: 2000 ms. operationId: v1DiagnosticsAgent_GetWebAppUsagesForPeriod 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.DiagnosticsCarriers.GetWebAppUsagesForPeriodRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetWebAppUsagesForPeriodRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetWebAppUsagesForPeriodRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetWebAppUsagesForPeriodRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetWebAppUsagesForPeriodRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetWebAppUsagesForPeriodRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetWebAppUsagesForPeriodRequest description: FromDate, ToDate, SearchTerm required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.WebAppUsage' text/json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.WebAppUsage' application/xml: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.WebAppUsage' text/xml: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.WebAppUsage' application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.WebAppUsage' application/merge-patch+json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.WebAppUsage' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetWebAppUsagesForPeriodRequest: description: >- GetWebAppUsagesForPeriod: Get all WebAppUsages for a given period, that match an optional search term type: object properties: FromDate: format: date-time type: string ToDate: format: date-time type: string SearchTerm: type: string SuperOffice.CRM.Services.WebAppUsage: description: "Carrier object for WebAppUsage.\r\nServices for the WebAppUsage Carrier is available from the Diagnostics Agent." type: object properties: WebAppUsageId: format: int32 description: Primary Key type: integer AssocId: format: int32 description: Associate Id type: integer Timestamp: format: date-time description: Which day the usage was logged type: string ViewState: description: The SoProtocol(ViewState) type: string AggregateCount: format: int32 description: Number of times the specific soprotocol is accessed type: integer AggregateBin: format: int32 description: '??' type: integer Version: format: int32 description: '??' 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.Diagnostics GetWebAppUsagesForPeriodRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Diagnostics_GetWebAppUsagesForPeriodRequest.md) - [NSDiagnosticsAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSDiagnosticsAgent.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) - [Web App Usage Exists In Period](/en/api/reference/restful/agent/diagnostics_agent/web-app-usage-exists-in-period.md) - [SuperOffice.WebApi.Data.Diagnostics WebAppUsageExistsInPeriodRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Diagnostics_WebAppUsageExistsInPeriodRequest.md)