GET api/analytics/{analysisId}

Run the desired analysis query against current data

Request Information

URI Parameters

Name	Description	Type	Additional information
analysisId	The id of the query to run	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

AnalyticQueryResult

Name	Type	Additional information
Query	AnalyticQueryDTO	None.
KeyQuestionsMetaData	Collection of ReportQuestionDetail	None.
Results	Collection of CaseAnalysisRecord	None.

Response Formats

application/json, text/json

Sample:

{
  "Query": {
    "Id": "42209b7a-34f4-459e-be7b-63e2fdb597d8",
    "Name": "sample string 2",
    "Template": "sample string 3",
    "OrganizationIds": [
      "f9535d1c-fb1f-45ef-81d6-c5f25d809e53",
      "bb47b78d-3569-4d82-89fe-7987ae172f50"
    ],
    "StartTimestamp": "2026-08-01T00:36:36.9263712+00:00",
    "EndTimestamp": "2026-08-01T00:36:36.9263712+00:00",
    "KeyQuestions": [
      "2cba6bfd-6686-457e-98a4-47a0403540a6",
      "32d0eac6-2c5c-474a-871a-13103a2c82c2"
    ],
    "KeyDate": "bc11d13f-32bd-4919-b840-f1d8a5edbe59",
    "QuestionFilters": [
      {
        "Id": "72b3951d-63e7-4deb-88b0-2f34300e942e",
        "Name": "sample string 2",
        "Text": "sample string 3",
        "Type": "sample string 4",
        "OrderIndex": 5,
        "Answers": null
      },
      {
        "Id": "72b3951d-63e7-4deb-88b0-2f34300e942e",
        "Name": "sample string 2",
        "Text": "sample string 3",
        "Type": "sample string 4",
        "OrderIndex": 5,
        "Answers": null
      }
    ],
    "StateFilters": [
      {
        "Id": "a6ba5673-e6c7-4782-9f6d-9bfdf98979cf",
        "Name": "sample string 2"
      },
      {
        "Id": "a6ba5673-e6c7-4782-9f6d-9bfdf98979cf",
        "Name": "sample string 2"
      }
    ],
    "IncludeBlanks": true,
    "Save": true
  },
  "KeyQuestionsMetaData": [
    {
      "Id": "72b3951d-63e7-4deb-88b0-2f34300e942e",
      "Name": "sample string 2",
      "Text": "sample string 3",
      "Type": "sample string 4",
      "OrderIndex": 5,
      "Answers": null
    },
    {
      "Id": "72b3951d-63e7-4deb-88b0-2f34300e942e",
      "Name": "sample string 2",
      "Text": "sample string 3",
      "Type": "sample string 4",
      "OrderIndex": 5,
      "Answers": null
    }
  ],
  "Results": [
    {
      "Id": "557ef377-7ee5-45e7-9190-928e4b52224a",
      "FriendlyId": "sample string 2",
      "Name": "sample string 3",
      "KeyDate": "2026-08-01T00:36:36.9263712+00:00",
      "CreatedTimestamp": "2026-08-01T00:36:36.9263712+00:00",
      "ModifiedTimestamp": "2026-08-01T00:36:36.9263712+00:00",
      "Keys": {
        "7c26f845-af98-4ef7-b1c0-559dcf84321f": "sample string 2",
        "6aa44c3c-2cca-4113-9021-9f0890314d6e": "sample string 4"
      }
    },
    {
      "Id": "557ef377-7ee5-45e7-9190-928e4b52224a",
      "FriendlyId": "sample string 2",
      "Name": "sample string 3",
      "KeyDate": "2026-08-01T00:36:36.9263712+00:00",
      "CreatedTimestamp": "2026-08-01T00:36:36.9263712+00:00",
      "ModifiedTimestamp": "2026-08-01T00:36:36.9263712+00:00",
      "Keys": {
        "7c26f845-af98-4ef7-b1c0-559dcf84321f": "sample string 2",
        "6aa44c3c-2cca-4113-9021-9f0890314d6e": "sample string 4"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<AnalyticQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XCapture.DTO">
  <KeyQuestionsMetaData>
    <ReportQuestionDetail>
      <Answers i:nil="true" />
      <Id>72b3951d-63e7-4deb-88b0-2f34300e942e</Id>
      <Name>sample string 2</Name>
      <Text>sample string 3</Text>
      <Type>sample string 4</Type>
    </ReportQuestionDetail>
    <ReportQuestionDetail>
      <Answers i:nil="true" />
      <Id>72b3951d-63e7-4deb-88b0-2f34300e942e</Id>
      <Name>sample string 2</Name>
      <Text>sample string 3</Text>
      <Type>sample string 4</Type>
    </ReportQuestionDetail>
  </KeyQuestionsMetaData>
  <Query>
    <EndTimestamp>2026-08-01T00:36:36.9263712+00:00</EndTimestamp>
    <Id>42209b7a-34f4-459e-be7b-63e2fdb597d8</Id>
    <IncludeBlanks>true</IncludeBlanks>
    <KeyDate>bc11d13f-32bd-4919-b840-f1d8a5edbe59</KeyDate>
    <KeyQuestions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>2cba6bfd-6686-457e-98a4-47a0403540a6</d3p1:guid>
      <d3p1:guid>32d0eac6-2c5c-474a-871a-13103a2c82c2</d3p1:guid>
    </KeyQuestions>
    <Name>sample string 2</Name>
    <OrganizationIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>f9535d1c-fb1f-45ef-81d6-c5f25d809e53</d3p1:guid>
      <d3p1:guid>bb47b78d-3569-4d82-89fe-7987ae172f50</d3p1:guid>
    </OrganizationIds>
    <QuestionFilters>
      <ReportQuestionDetail>
        <Answers i:nil="true" />
        <Id>72b3951d-63e7-4deb-88b0-2f34300e942e</Id>
        <Name>sample string 2</Name>
        <Text>sample string 3</Text>
        <Type>sample string 4</Type>
      </ReportQuestionDetail>
      <ReportQuestionDetail>
        <Answers i:nil="true" />
        <Id>72b3951d-63e7-4deb-88b0-2f34300e942e</Id>
        <Name>sample string 2</Name>
        <Text>sample string 3</Text>
        <Type>sample string 4</Type>
      </ReportQuestionDetail>
    </QuestionFilters>
    <Save>true</Save>
    <StartTimestamp>2026-08-01T00:36:36.9263712+00:00</StartTimestamp>
    <StateFilters>
      <StateSimple>
        <Id>a6ba5673-e6c7-4782-9f6d-9bfdf98979cf</Id>
        <Name>sample string 2</Name>
      </StateSimple>
      <StateSimple>
        <Id>a6ba5673-e6c7-4782-9f6d-9bfdf98979cf</Id>
        <Name>sample string 2</Name>
      </StateSimple>
    </StateFilters>
    <Template>sample string 3</Template>
  </Query>
  <Results>
    <CaseAnalysisRecord>
      <CreatedTimestamp>2026-08-01T00:36:36.9263712+00:00</CreatedTimestamp>
      <FriendlyId>sample string 2</FriendlyId>
      <Id>557ef377-7ee5-45e7-9190-928e4b52224a</Id>
      <KeyDate>2026-08-01T00:36:36.9263712+00:00</KeyDate>
      <Keys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfguidstring>
          <d4p1:Key>7c26f845-af98-4ef7-b1c0-559dcf84321f</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfguidstring>
        <d4p1:KeyValueOfguidstring>
          <d4p1:Key>6aa44c3c-2cca-4113-9021-9f0890314d6e</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfguidstring>
      </Keys>
      <ModifiedTimestamp>2026-08-01T00:36:36.9263712+00:00</ModifiedTimestamp>
      <Name>sample string 3</Name>
    </CaseAnalysisRecord>
    <CaseAnalysisRecord>
      <CreatedTimestamp>2026-08-01T00:36:36.9263712+00:00</CreatedTimestamp>
      <FriendlyId>sample string 2</FriendlyId>
      <Id>557ef377-7ee5-45e7-9190-928e4b52224a</Id>
      <KeyDate>2026-08-01T00:36:36.9263712+00:00</KeyDate>
      <Keys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfguidstring>
          <d4p1:Key>7c26f845-af98-4ef7-b1c0-559dcf84321f</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfguidstring>
        <d4p1:KeyValueOfguidstring>
          <d4p1:Key>6aa44c3c-2cca-4113-9021-9f0890314d6e</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfguidstring>
      </Keys>
      <ModifiedTimestamp>2026-08-01T00:36:36.9263712+00:00</ModifiedTimestamp>
      <Name>sample string 3</Name>
    </CaseAnalysisRecord>
  </Results>
</AnalyticQueryResult>