GET v1/Surveys/{surveyId}/Performance/Metrics/Live

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Supervisor Scripter LimitedUser OperationsUser DemoUser

Permissions required to make this request: SurveyInterviewMetric.Read Survey.Read

Supports survey simulations

Get the survey performance metrics for live interviews

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The id of the survey	string	Required

Body Parameters

None.

Response Information

Resource Description

The survey performance metrics. The possible metric names are: - Page Complexity - Expression Complexity - Interview State Size - Expensive Command Count

Response Message

SurveyMetrics

Name	Description	Type	Additional information
Id	The id of the survey	string	None.
PublishedCount	The number of interviews for the current published version of the survey	integer	None.
TotalCount	The total number of interviews for this survey	integer	None.
Counts	The warn and blocked counts per metric	Collection of SurveyMetricCounts	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "PublishedCount": 2,
  "TotalCount": 3,
  "Counts": [
    {
      "MetricName": "sample string 1",
      "All": {
        "Warn": 1,
        "Block": 2
      },
      "Published": {
        "Warn": 1,
        "Block": 2
      }
    },
    {
      "MetricName": "sample string 1",
      "All": {
        "Warn": 1,
        "Block": 2
      },
      "Published": {
        "Warn": 1,
        "Block": 2
      }
    }
  ]
}

application/xml, text/xml

Sample:

<SurveyMetrics xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Counts>
    <SurveyMetricCounts>
      <All>
        <Block>2</Block>
        <Warn>1</Warn>
      </All>
      <MetricName>sample string 1</MetricName>
      <Published>
        <Block>2</Block>
        <Warn>1</Warn>
      </Published>
    </SurveyMetricCounts>
    <SurveyMetricCounts>
      <All>
        <Block>2</Block>
        <Warn>1</Warn>
      </All>
      <MetricName>sample string 1</MetricName>
      <Published>
        <Block>2</Block>
        <Warn>1</Warn>
      </Published>
    </SurveyMetricCounts>
  </Counts>
  <Id>sample string 1</Id>
  <PublishedCount>2</PublishedCount>
  <TotalCount>3</TotalCount>
</SurveyMetrics>