POST api/Analytics

Add a new AnalyticQuery

Request Information

URI Parameters

None.

Body Parameters

The Name, OutputQuestionId, and FilterQuestions are used to build the query object

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	None.
Template	string	None.
OrganizationIds	Collection of globally unique identifier	None.
StartTimestamp	date	None.
EndTimestamp	date	None.
KeyQuestions	Collection of globally unique identifier	None.
KeyDate	globally unique identifier	None.
QuestionFilters	Collection of ReportQuestionDetail	None.
StateFilters	Collection of StateSimple	None.
IncludeBlanks	boolean	None.
Save	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "096ae7f5-9ff7-4c5f-8f05-bd3897f11149",
  "Name": "sample string 2",
  "Template": "sample string 3",
  "OrganizationIds": [
    "7ebae11d-1ad6-4927-b07f-479869721124",
    "1ece1ce9-1db2-49db-8d29-0409dbf77d93"
  ],
  "StartTimestamp": "2025-12-14T19:14:27.4367117+00:00",
  "EndTimestamp": "2025-12-14T19:14:27.4367117+00:00",
  "KeyQuestions": [
    "d30ddde5-00c2-4b34-800b-c7023454c0ac",
    "6d8faa3a-fcbe-4ec1-8f20-354261a8a40b"
  ],
  "KeyDate": "f2dfb53f-185d-4bd8-b5ca-f7b8553d1241",
  "QuestionFilters": [
    {
      "Id": "a8e57422-6ed2-422a-96e0-e4274cfffd85",
      "Name": "sample string 2",
      "Text": "sample string 3",
      "Type": "sample string 4",
      "OrderIndex": 5,
      "Answers": null
    },
    {
      "Id": "a8e57422-6ed2-422a-96e0-e4274cfffd85",
      "Name": "sample string 2",
      "Text": "sample string 3",
      "Type": "sample string 4",
      "OrderIndex": 5,
      "Answers": null
    }
  ],
  "StateFilters": [
    {
      "Id": "c4b5dde8-2baf-4742-b0d6-cbf12765e755",
      "Name": "sample string 2"
    },
    {
      "Id": "c4b5dde8-2baf-4742-b0d6-cbf12765e755",
      "Name": "sample string 2"
    }
  ],
  "IncludeBlanks": true,
  "Save": true
}

application/xml, text/xml

Sample:

<AnalyticQueryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XCapture.DTO">
  <EndTimestamp>2025-12-14T19:14:27.4367117+00:00</EndTimestamp>
  <Id>096ae7f5-9ff7-4c5f-8f05-bd3897f11149</Id>
  <IncludeBlanks>true</IncludeBlanks>
  <KeyDate>f2dfb53f-185d-4bd8-b5ca-f7b8553d1241</KeyDate>
  <KeyQuestions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>d30ddde5-00c2-4b34-800b-c7023454c0ac</d2p1:guid>
    <d2p1:guid>6d8faa3a-fcbe-4ec1-8f20-354261a8a40b</d2p1:guid>
  </KeyQuestions>
  <Name>sample string 2</Name>
  <OrganizationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>7ebae11d-1ad6-4927-b07f-479869721124</d2p1:guid>
    <d2p1:guid>1ece1ce9-1db2-49db-8d29-0409dbf77d93</d2p1:guid>
  </OrganizationIds>
  <QuestionFilters>
    <ReportQuestionDetail>
      <Answers i:nil="true" />
      <Id>a8e57422-6ed2-422a-96e0-e4274cfffd85</Id>
      <Name>sample string 2</Name>
      <Text>sample string 3</Text>
      <Type>sample string 4</Type>
    </ReportQuestionDetail>
    <ReportQuestionDetail>
      <Answers i:nil="true" />
      <Id>a8e57422-6ed2-422a-96e0-e4274cfffd85</Id>
      <Name>sample string 2</Name>
      <Text>sample string 3</Text>
      <Type>sample string 4</Type>
    </ReportQuestionDetail>
  </QuestionFilters>
  <Save>true</Save>
  <StartTimestamp>2025-12-14T19:14:27.4367117+00:00</StartTimestamp>
  <StateFilters>
    <StateSimple>
      <Id>c4b5dde8-2baf-4742-b0d6-cbf12765e755</Id>
      <Name>sample string 2</Name>
    </StateSimple>
    <StateSimple>
      <Id>c4b5dde8-2baf-4742-b0d6-cbf12765e755</Id>
      <Name>sample string 2</Name>
    </StateSimple>
  </StateFilters>
  <Template>sample string 3</Template>
</AnalyticQueryDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AnalyticQueryDTO'.

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": "4c2e6358-5733-4c89-bcab-ccac1af350bf",
    "Name": "sample string 2",
    "Template": "sample string 3",
    "OrganizationIds": [
      "291339da-4522-4763-bcbf-605f746ab76c",
      "1f849b8d-f959-4ce7-9e04-55b6ce6cf322"
    ],
    "StartTimestamp": "2025-12-14T19:14:27.4367117+00:00",
    "EndTimestamp": "2025-12-14T19:14:27.4367117+00:00",
    "KeyQuestions": [
      "ca87c5ba-a172-4085-b515-e35518fd6ef9",
      "bbdeccbf-ad09-46c5-b31f-739f9b9c19fe"
    ],
    "KeyDate": "aa52da5d-c93a-4499-a736-90cbca3dcc7c",
    "QuestionFilters": [
      {
        "Id": "470c612e-8d8f-4c38-b282-d8119a1d9a26",
        "Name": "sample string 2",
        "Text": "sample string 3",
        "Type": "sample string 4",
        "OrderIndex": 5,
        "Answers": null
      },
      {
        "Id": "470c612e-8d8f-4c38-b282-d8119a1d9a26",
        "Name": "sample string 2",
        "Text": "sample string 3",
        "Type": "sample string 4",
        "OrderIndex": 5,
        "Answers": null
      }
    ],
    "StateFilters": [
      {
        "Id": "3e33fec8-3717-4817-b2b0-ae587f116f92",
        "Name": "sample string 2"
      },
      {
        "Id": "3e33fec8-3717-4817-b2b0-ae587f116f92",
        "Name": "sample string 2"
      }
    ],
    "IncludeBlanks": true,
    "Save": true
  },
  "KeyQuestionsMetaData": [
    {
      "Id": "470c612e-8d8f-4c38-b282-d8119a1d9a26",
      "Name": "sample string 2",
      "Text": "sample string 3",
      "Type": "sample string 4",
      "OrderIndex": 5,
      "Answers": null
    },
    {
      "Id": "470c612e-8d8f-4c38-b282-d8119a1d9a26",
      "Name": "sample string 2",
      "Text": "sample string 3",
      "Type": "sample string 4",
      "OrderIndex": 5,
      "Answers": null
    }
  ],
  "Results": [
    {
      "Id": "4a8dbf83-fb8b-4520-911e-91759fb18348",
      "FriendlyId": "sample string 2",
      "Name": "sample string 3",
      "KeyDate": "2025-12-14T19:14:27.4367117+00:00",
      "CreatedTimestamp": "2025-12-14T19:14:27.4367117+00:00",
      "ModifiedTimestamp": "2025-12-14T19:14:27.4367117+00:00",
      "Keys": {
        "cecb8b9b-8134-4ca4-9d9a-9c8c018a9ac5": "sample string 2",
        "de787b29-e3ca-4809-aee3-8bb82bf380f5": "sample string 4"
      }
    },
    {
      "Id": "4a8dbf83-fb8b-4520-911e-91759fb18348",
      "FriendlyId": "sample string 2",
      "Name": "sample string 3",
      "KeyDate": "2025-12-14T19:14:27.4367117+00:00",
      "CreatedTimestamp": "2025-12-14T19:14:27.4367117+00:00",
      "ModifiedTimestamp": "2025-12-14T19:14:27.4367117+00:00",
      "Keys": {
        "cecb8b9b-8134-4ca4-9d9a-9c8c018a9ac5": "sample string 2",
        "de787b29-e3ca-4809-aee3-8bb82bf380f5": "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>470c612e-8d8f-4c38-b282-d8119a1d9a26</Id>
      <Name>sample string 2</Name>
      <Text>sample string 3</Text>
      <Type>sample string 4</Type>
    </ReportQuestionDetail>
    <ReportQuestionDetail>
      <Answers i:nil="true" />
      <Id>470c612e-8d8f-4c38-b282-d8119a1d9a26</Id>
      <Name>sample string 2</Name>
      <Text>sample string 3</Text>
      <Type>sample string 4</Type>
    </ReportQuestionDetail>
  </KeyQuestionsMetaData>
  <Query>
    <EndTimestamp>2025-12-14T19:14:27.4367117+00:00</EndTimestamp>
    <Id>4c2e6358-5733-4c89-bcab-ccac1af350bf</Id>
    <IncludeBlanks>true</IncludeBlanks>
    <KeyDate>aa52da5d-c93a-4499-a736-90cbca3dcc7c</KeyDate>
    <KeyQuestions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>ca87c5ba-a172-4085-b515-e35518fd6ef9</d3p1:guid>
      <d3p1:guid>bbdeccbf-ad09-46c5-b31f-739f9b9c19fe</d3p1:guid>
    </KeyQuestions>
    <Name>sample string 2</Name>
    <OrganizationIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>291339da-4522-4763-bcbf-605f746ab76c</d3p1:guid>
      <d3p1:guid>1f849b8d-f959-4ce7-9e04-55b6ce6cf322</d3p1:guid>
    </OrganizationIds>
    <QuestionFilters>
      <ReportQuestionDetail>
        <Answers i:nil="true" />
        <Id>470c612e-8d8f-4c38-b282-d8119a1d9a26</Id>
        <Name>sample string 2</Name>
        <Text>sample string 3</Text>
        <Type>sample string 4</Type>
      </ReportQuestionDetail>
      <ReportQuestionDetail>
        <Answers i:nil="true" />
        <Id>470c612e-8d8f-4c38-b282-d8119a1d9a26</Id>
        <Name>sample string 2</Name>
        <Text>sample string 3</Text>
        <Type>sample string 4</Type>
      </ReportQuestionDetail>
    </QuestionFilters>
    <Save>true</Save>
    <StartTimestamp>2025-12-14T19:14:27.4367117+00:00</StartTimestamp>
    <StateFilters>
      <StateSimple>
        <Id>3e33fec8-3717-4817-b2b0-ae587f116f92</Id>
        <Name>sample string 2</Name>
      </StateSimple>
      <StateSimple>
        <Id>3e33fec8-3717-4817-b2b0-ae587f116f92</Id>
        <Name>sample string 2</Name>
      </StateSimple>
    </StateFilters>
    <Template>sample string 3</Template>
  </Query>
  <Results>
    <CaseAnalysisRecord>
      <CreatedTimestamp>2025-12-14T19:14:27.4367117+00:00</CreatedTimestamp>
      <FriendlyId>sample string 2</FriendlyId>
      <Id>4a8dbf83-fb8b-4520-911e-91759fb18348</Id>
      <KeyDate>2025-12-14T19:14:27.4367117+00:00</KeyDate>
      <Keys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfguidstring>
          <d4p1:Key>cecb8b9b-8134-4ca4-9d9a-9c8c018a9ac5</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfguidstring>
        <d4p1:KeyValueOfguidstring>
          <d4p1:Key>de787b29-e3ca-4809-aee3-8bb82bf380f5</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfguidstring>
      </Keys>
      <ModifiedTimestamp>2025-12-14T19:14:27.4367117+00:00</ModifiedTimestamp>
      <Name>sample string 3</Name>
    </CaseAnalysisRecord>
    <CaseAnalysisRecord>
      <CreatedTimestamp>2025-12-14T19:14:27.4367117+00:00</CreatedTimestamp>
      <FriendlyId>sample string 2</FriendlyId>
      <Id>4a8dbf83-fb8b-4520-911e-91759fb18348</Id>
      <KeyDate>2025-12-14T19:14:27.4367117+00:00</KeyDate>
      <Keys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfguidstring>
          <d4p1:Key>cecb8b9b-8134-4ca4-9d9a-9c8c018a9ac5</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfguidstring>
        <d4p1:KeyValueOfguidstring>
          <d4p1:Key>de787b29-e3ca-4809-aee3-8bb82bf380f5</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfguidstring>
      </Keys>
      <ModifiedTimestamp>2025-12-14T19:14:27.4367117+00:00</ModifiedTimestamp>
      <Name>sample string 3</Name>
    </CaseAnalysisRecord>
  </Results>
</AnalyticQueryResult>