> ## Documentation Index > Fetch the complete documentation index at: https://docs.repdata.com/llms.txt > Use this file to discover all available pages before exploring further. # Fetch Cluster Analysis > # Description Get analysis data for questions using clusters. # Payload ```json { "fromDate": string, "toDate": string, "filter": array, "groups": object, "clusterOptions": object, "excludeQuestions": array } ``` where: * `fromDate`: start date in ISO format. **Required**. * `toDate`: end date in ISO format. **Required**. * `filter`: array of filters to filter the responses. Optional. * `groups`: Object indexed by question id with a `q` as prefix. Every key has assigned an array with the question ids with `q` prefix that are the same question through different concepts inside a concept test. Only needed for project with Concept Test or Question Loops. Optional. * `clusterOptions`: Object indexed by cluster name. Every cluster has an array with the same structure as filter. **Required**. * `excludeQuestions`: Array of question ids. Questions specified in this array belong to a Contact Info item, specifically the country and state questions that should be excluded from analysis. Optional. # Response ## 200 OK ```json { "projectId": string, "fromDate": string, "toDate": string, "dateFilters": array, "filter": array, "responses": { "q000000000000000000000000": object, "q000000000000000000000001": object }, "responsesCounter": { "1": number, "5": number } } ``` where: * `projectId`: unique identifier of the project. * `fromDate`: start date received as param to the query in ISO format. * `toDate`: end date received as param to the query in ISO format. * `dateFilters`: Array of date filters used for querying the responses. * `filter`: Array of filters sent in the request. * `responses`: object mapping unique question identifiers to cluster analysis data for every question. * `responsesCounter`: Object containing the number of responses per question for the given filter. ## 400 Bad Request > Missing or invalid `projectId`/`fromDate`/`toDate` fields. ## 401 Unauthorized > The user doesn't have permissions. ## 404 Not Found > Resource not found. ## 500 Internal Server Error > Error occurred in the service. # Description Get analysis data for questions using clusters. # Payload ```json theme={null} { "fromDate": string, "toDate": string, "filter": array, "groups": object, "clusterOptions": object, "excludeQuestions": array } ``` where: * `fromDate`: start date in ISO format. **Required**. * `toDate`: end date in ISO format. **Required**. * `filter`: array of filters to filter the responses. Optional. * `groups`: Object indexed by question id with a `q` as prefix. Every key has assigned an array with the question ids with `q` prefix that are the same question through different concepts inside a concept test. Only needed for project with Concept Test or Question Loops. Optional. * `clusterOptions`: Object indexed by cluster name. Every cluster has an array with the same structure as filter. **Required**. * `excludeQuestions`: Array of question ids. Questions specified in this array belong to a Contact Info item, specifically the country and state questions that should be excluded from analysis. Optional. # Response ## 200 OK ```json theme={null} { "projectId": string, "fromDate": string, "toDate": string, "dateFilters": array, "filter": array, "responses": { "q000000000000000000000000": object, "q000000000000000000000001": object }, "responsesCounter": { "1": number, "5": number } } ``` where: * `projectId`: unique identifier of the project. * `fromDate`: start date received as param to the query in ISO format. * `toDate`: end date received as param to the query in ISO format. * `dateFilters`: Array of date filters used for querying the responses. * `filter`: Array of filters sent in the request. * `responses`: object mapping unique question identifiers to cluster analysis data for every question. * `responsesCounter`: Object containing the number of responses per question for the given filter. ## 400 Bad Request > Missing or invalid `projectId`/`fromDate`/`toDate` fields. ## 401 Unauthorized > The user doesn't have permissions. ## 404 Not Found > Resource not found. ## 500 Internal Server Error > Error occurred in the service. ##### Query Parameters | Parameter | Description | Required | Example | | ----------- | ----------- | -------- | ------- | | `projectId` | — | No | — | ## OpenAPI ````yaml POST /multiple-question-analysis-service/cluster openapi: 3.0.3 info: title: SightX API version: 1.0.0 description: >- SightX REST API documentation. Most responses are JSON; some export endpoints return files. API access is a paid add-on — contact sales@sightx.io for details. servers: - url: https://auth.admin.sightx.io description: Authentication (Production) - url: https://auth.staging-admin.sightx.io description: Authentication (Staging) security: - AuthorizationHeader: [] paths: /multiple-question-analysis-service/cluster: post: summary: Fetch Cluster Analysis description: >- # Description Get analysis data for questions using clusters. # Payload ```json { "fromDate": string, "toDate": string, "filter": array, "groups": object, "clusterOptions": object, "excludeQuestions": array } ``` where: * `fromDate`: start date in ISO format. **Required**. * `toDate`: end date in ISO format. **Required**. * `filter`: array of filters to filter the responses. Optional. * `groups`: Object indexed by question id with a `q` as prefix. Every key has assigned an array with the question ids with `q` prefix that are the same question through different concepts inside a concept test. Only needed for project with Concept Test or Question Loops. Optional. * `clusterOptions`: Object indexed by cluster name. Every cluster has an array with the same structure as filter. **Required**. * `excludeQuestions`: Array of question ids. Questions specified in this array belong to a Contact Info item, specifically the country and state questions that should be excluded from analysis. Optional. # Response ## 200 OK ```json { "projectId": string, "fromDate": string, "toDate": string, "dateFilters": array, "filter": array, "responses": { "q000000000000000000000000": object, "q000000000000000000000001": object }, "responsesCounter": { "1": number, "5": number } } ``` where: * `projectId`: unique identifier of the project. * `fromDate`: start date received as param to the query in ISO format. * `toDate`: end date received as param to the query in ISO format. * `dateFilters`: Array of date filters used for querying the responses. * `filter`: Array of filters sent in the request. * `responses`: object mapping unique question identifiers to cluster analysis data for every question. * `responsesCounter`: Object containing the number of responses per question for the given filter. ## 400 Bad Request > Missing or invalid `projectId`/`fromDate`/`toDate` fields. ## 401 Unauthorized > The user doesn't have permissions. ## 404 Not Found > Resource not found. ## 500 Internal Server Error > Error occurred in the service. operationId: fetch-cluster-analysis-post-multiple-question-analysis-service-cluster parameters: - name: Authorization in: header required: true description: Authorization token schema: type: string - name: projectId in: query required: false schema: type: string requestBody: required: true content: application/json: schema: type: object additionalProperties: true example: fromDate: '2020-01-01' toDate: '2022-12-31' filter: [] groups: qQuestionId: - qRelatedQuestionId1 - qRelatedQuestionId1 clusterOptions: clusterName: [] excludeQuestions: [] responses: '200': description: Fetch Cluster Analysis content: application/json: schema: type: object additionalProperties: true example: projectId: 60de2ba329a7230061e209f6 fromDate: '2020-01-01' toDate: '2022-12-31' filter: [] dateFilters: - collection: year start: '2020-01-01' end: '2022-12-31' responsesCounter: clusterName: 8 responses: qQuestionId: clusterName: responses: 0 mean: NaN median: 0 mode: [] variance: NaN standardDeviation: NaN frecuency: [] percent: [] cumulativeFrecuency: [] cumulativeFrecuencyByVotes: [] cumulativePercent: [] cumulativePercentByVotes: [] responsesCounter: clusterName: responses: 0 mean: NaN median: 0 mode: [] variance: NaN standardDeviation: NaN frecuency: [] percent: [] cumulativeFrecuency: [] cumulativeFrecuencyByVotes: [] cumulativePercent: [] cumulativePercentByVotes: [] responsesCounters: clusterName: responses: 16 mean: NaN median: null mode: - null variance: NaN standardDeviation: NaN frecuency: - count: 16 value: QuestionId percent: - count: '100.00' value: QuestionId cumulativeFrecuency: - count: 16 value: QuestionId cumulativeFrecuencyByVotes: - count: 16 value: QuestionId cumulativePercent: - count: '100.00' value: QuestionId cumulativePercentByVotes: - count: '100.00' value: QuestionId responsesByQuestionCounter: clusterName: responses: 167 mean: '0.00' median: '0.00' mode: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 variance: '0.00' standardDeviation: '0.00' frecuency: - count: 8 value: 0de2bb029a7230061e209f8 - count: 3 value: 0de2c6effcabb005be29616 - count: 3 value: 0de33c629a7230061e20a7c - count: 3 value: 0de34bbffcabb005be29765 - count: 1 value: 0de341029a7230061e20afc - count: 1 value: 0de341029a7230061e20afd - count: 1 value: 0de34bbffcabb005be29766 - count: 2 value: 0de341029a7230061e20b01 - count: 2 value: 0de341029a7230061e20b02 - count: 2 value: 0de34bbffcabb005be29767 - count: 3 value: 0de341029a7230061e20b06 - count: 3 value: 0de341029a7230061e20b07 - count: 3 value: 0de34bbffcabb005be29768 - count: 0 value: 0de341029a7230061e20b0b - count: 0 value: 0de341029a7230061e20b0c - count: 0 value: 0de34bbffcabb005be29769 - count: 8 value: 0de3528ffcabb005be29835 - count: 8 value: 0de3528ffcabb005be29836 - count: 8 value: 0de3528ffcabb005be29841 - count: 8 value: 0de3564ffcabb005be29b07 - count: 8 value: 0de3564ffcabb005be29b08 - count: 8 value: 0de3564ffcabb005be29b13 - count: 8 value: 0de3564ffcabb005be29b18 - count: 8 value: 0de3564ffcabb005be29b19 - count: 8 value: 0de3564ffcabb005be29b24 - count: 4 value: 0de355bffcabb005be29ad3 - count: 4 value: 0de355bffcabb005be29ad4 - count: 4 value: 0de355bffcabb005be29adf - count: 7 value: 0de3564ffcabb005be29b2a - count: 7 value: 0de3564ffcabb005be29b2b - count: 7 value: 0de3564ffcabb005be29b36 - count: 5 value: 0de3564ffcabb005be29b3b - count: 5 value: 0de3564ffcabb005be29b3c - count: 5 value: 0de3564ffcabb005be29b47 - count: 4 value: 0de3564ffcabb005be29b4c - count: 4 value: 0de3564ffcabb005be29b4d - count: 4 value: 0de3564ffcabb005be29b58 percent: - count: '4.79' value: 0de2bb029a7230061e209f8 - count: '1.80' value: 0de2c6effcabb005be29616 - count: '1.80' value: 0de33c629a7230061e20a7c - count: '1.80' value: 0de34bbffcabb005be29765 - count: '0.60' value: 0de341029a7230061e20afc - count: '0.60' value: 0de341029a7230061e20afd - count: '0.60' value: 0de34bbffcabb005be29766 - count: '1.20' value: 0de341029a7230061e20b01 - count: '1.20' value: 0de341029a7230061e20b02 - count: '1.20' value: 0de34bbffcabb005be29767 - count: '1.80' value: 0de341029a7230061e20b06 - count: '1.80' value: 0de341029a7230061e20b07 - count: '1.80' value: 0de34bbffcabb005be29768 - count: '0.00' value: 0de341029a7230061e20b0b - count: '0.00' value: 0de341029a7230061e20b0c - count: '0.00' value: 0de34bbffcabb005be29769 - count: '4.79' value: 0de3528ffcabb005be29835 - count: '4.79' value: 0de3528ffcabb005be29836 - count: '4.79' value: 0de3528ffcabb005be29841 - count: '4.79' value: 0de3564ffcabb005be29b07 - count: '4.79' value: 0de3564ffcabb005be29b08 - count: '4.79' value: 0de3564ffcabb005be29b13 - count: '4.79' value: 0de3564ffcabb005be29b18 - count: '4.79' value: 0de3564ffcabb005be29b19 - count: '4.79' value: 0de3564ffcabb005be29b24 - count: '2.40' value: 0de355bffcabb005be29ad3 - count: '2.40' value: 0de355bffcabb005be29ad4 - count: '2.40' value: 0de355bffcabb005be29adf - count: '4.19' value: 0de3564ffcabb005be29b2a - count: '4.19' value: 0de3564ffcabb005be29b2b - count: '4.19' value: 0de3564ffcabb005be29b36 - count: '2.99' value: 0de3564ffcabb005be29b3b - count: '2.99' value: 0de3564ffcabb005be29b3c - count: '2.99' value: 0de3564ffcabb005be29b47 - count: '2.40' value: 0de3564ffcabb005be29b4c - count: '2.40' value: 0de3564ffcabb005be29b4d - count: '2.40' value: 0de3564ffcabb005be29b58 cumulativeFrecuency: - count: 8 value: 0de2bb029a7230061e209f8 - count: 11 value: 0de2c6effcabb005be29616 - count: 14 value: 0de33c629a7230061e20a7c - count: 17 value: 0de34bbffcabb005be29765 - count: 18 value: 0de341029a7230061e20afc - count: 19 value: 0de341029a7230061e20afd - count: 20 value: 0de34bbffcabb005be29766 - count: 22 value: 0de341029a7230061e20b01 - count: 24 value: 0de341029a7230061e20b02 - count: 26 value: 0de34bbffcabb005be29767 - count: 29 value: 0de341029a7230061e20b06 - count: 32 value: 0de341029a7230061e20b07 - count: 35 value: 0de34bbffcabb005be29768 - count: 35 value: 0de341029a7230061e20b0b - count: 35 value: 0de341029a7230061e20b0c - count: 35 value: 0de34bbffcabb005be29769 - count: 43 value: 0de3528ffcabb005be29835 - count: 51 value: 0de3528ffcabb005be29836 - count: 59 value: 0de3528ffcabb005be29841 - count: 67 value: 0de3564ffcabb005be29b07 - count: 75 value: 0de3564ffcabb005be29b08 - count: 83 value: 0de3564ffcabb005be29b13 - count: 91 value: 0de3564ffcabb005be29b18 - count: 99 value: 0de3564ffcabb005be29b19 - count: 107 value: 0de3564ffcabb005be29b24 - count: 111 value: 0de355bffcabb005be29ad3 - count: 115 value: 0de355bffcabb005be29ad4 - count: 119 value: 0de355bffcabb005be29adf - count: 126 value: 0de3564ffcabb005be29b2a - count: 133 value: 0de3564ffcabb005be29b2b - count: 140 value: 0de3564ffcabb005be29b36 - count: 145 value: 0de3564ffcabb005be29b3b - count: 150 value: 0de3564ffcabb005be29b3c - count: 155 value: 0de3564ffcabb005be29b47 - count: 159 value: 0de3564ffcabb005be29b4c - count: 163 value: 0de3564ffcabb005be29b4d - count: 167 value: 0de3564ffcabb005be29b58 cumulativeFrecuencyByVotes: - count: 8 value: 0de3528ffcabb005be29841 - count: 16 value: 0de2bb029a7230061e209f8 - count: 19 value: 0de33c629a7230061e20a7c - count: 22 value: 0de34bbffcabb005be29765 - count: 23 value: 0de341029a7230061e20afc - count: 24 value: 0de341029a7230061e20afd - count: 25 value: 0de34bbffcabb005be29766 - count: 27 value: 0de341029a7230061e20b01 - count: 29 value: 0de341029a7230061e20b02 - count: 31 value: 0de34bbffcabb005be29767 - count: 34 value: 0de341029a7230061e20b06 - count: 37 value: 0de341029a7230061e20b07 - count: 40 value: 0de34bbffcabb005be29768 - count: 40 value: 0de341029a7230061e20b0b - count: 40 value: 0de341029a7230061e20b0c - count: 40 value: 0de34bbffcabb005be29769 - count: 48 value: 0de3528ffcabb005be29835 - count: 56 value: 0de3528ffcabb005be29836 - count: 59 value: 0de2c6effcabb005be29616 - count: 67 value: 0de3564ffcabb005be29b07 - count: 75 value: 0de3564ffcabb005be29b08 - count: 83 value: 0de3564ffcabb005be29b13 - count: 91 value: 0de3564ffcabb005be29b18 - count: 99 value: 0de3564ffcabb005be29b19 - count: 107 value: 0de3564ffcabb005be29b24 - count: 111 value: 0de355bffcabb005be29ad3 - count: 115 value: 0de355bffcabb005be29ad4 - count: 119 value: 0de355bffcabb005be29adf - count: 126 value: 0de3564ffcabb005be29b2a - count: 133 value: 0de3564ffcabb005be29b2b - count: 140 value: 0de3564ffcabb005be29b36 - count: 145 value: 0de3564ffcabb005be29b3b - count: 150 value: 0de3564ffcabb005be29b3c - count: 155 value: 0de3564ffcabb005be29b47 - count: 159 value: 0de3564ffcabb005be29b4c - count: 163 value: 0de3564ffcabb005be29b4d - count: 167 value: 0de3564ffcabb005be29b58 cumulativePercent: - count: '4.79' value: 0de2bb029a7230061e209f8 - count: '6.59' value: 0de2c6effcabb005be29616 - count: '8.38' value: 0de33c629a7230061e20a7c - count: '10.18' value: 0de34bbffcabb005be29765 - count: '10.78' value: 0de341029a7230061e20afc - count: '11.38' value: 0de341029a7230061e20afd - count: '11.98' value: 0de34bbffcabb005be29766 - count: '13.17' value: 0de341029a7230061e20b01 - count: '14.37' value: 0de341029a7230061e20b02 - count: '15.57' value: 0de34bbffcabb005be29767 - count: '17.37' value: 0de341029a7230061e20b06 - count: '19.16' value: 0de341029a7230061e20b07 - count: '20.96' value: 0de34bbffcabb005be29768 - count: '20.96' value: 0de341029a7230061e20b0b - count: '20.96' value: 0de341029a7230061e20b0c - count: '20.96' value: 0de34bbffcabb005be29769 - count: '25.75' value: 0de3528ffcabb005be29835 - count: '30.54' value: 0de3528ffcabb005be29836 - count: '35.33' value: 0de3528ffcabb005be29841 - count: '40.12' value: 0de3564ffcabb005be29b07 - count: '44.91' value: 0de3564ffcabb005be29b08 - count: '49.70' value: 0de3564ffcabb005be29b13 - count: '54.49' value: 0de3564ffcabb005be29b18 - count: '59.28' value: 0de3564ffcabb005be29b19 - count: '64.07' value: 0de3564ffcabb005be29b24 - count: '66.47' value: 0de355bffcabb005be29ad3 - count: '68.86' value: 0de355bffcabb005be29ad4 - count: '71.26' value: 0de355bffcabb005be29adf - count: '75.45' value: 0de3564ffcabb005be29b2a - count: '79.64' value: 0de3564ffcabb005be29b2b - count: '83.83' value: 0de3564ffcabb005be29b36 - count: '86.83' value: 0de3564ffcabb005be29b3b - count: '89.82' value: 0de3564ffcabb005be29b3c - count: '92.81' value: 0de3564ffcabb005be29b47 - count: '95.21' value: 0de3564ffcabb005be29b4c - count: '97.60' value: 0de3564ffcabb005be29b4d - count: '100.00' value: 0de3564ffcabb005be29b58 cumulativePercentByVotes: - count: '4.79' value: 0de3528ffcabb005be29841 - count: '9.58' value: 0de2bb029a7230061e209f8 - count: '11.38' value: 0de33c629a7230061e20a7c - count: '13.17' value: 0de34bbffcabb005be29765 - count: '13.77' value: 0de341029a7230061e20afc - count: '14.37' value: 0de341029a7230061e20afd - count: '14.97' value: 0de34bbffcabb005be29766 - count: '16.17' value: 0de341029a7230061e20b01 - count: '17.37' value: 0de341029a7230061e20b02 - count: '18.56' value: 0de34bbffcabb005be29767 - count: '20.36' value: 0de341029a7230061e20b06 - count: '22.16' value: 0de341029a7230061e20b07 - count: '23.95' value: 0de34bbffcabb005be29768 - count: '23.95' value: 0de341029a7230061e20b0b - count: '23.95' value: 0de341029a7230061e20b0c - count: '23.95' value: 0de34bbffcabb005be29769 - count: '28.74' value: 0de3528ffcabb005be29835 - count: '33.53' value: 0de3528ffcabb005be29836 - count: '35.33' value: 0de2c6effcabb005be29616 - count: '40.12' value: 0de3564ffcabb005be29b07 - count: '44.91' value: 0de3564ffcabb005be29b08 - count: '49.70' value: 0de3564ffcabb005be29b13 - count: '54.49' value: 0de3564ffcabb005be29b18 - count: '59.28' value: 0de3564ffcabb005be29b19 - count: '64.07' value: 0de3564ffcabb005be29b24 - count: '66.47' value: 0de355bffcabb005be29ad3 - count: '68.86' value: 0de355bffcabb005be29ad4 - count: '71.26' value: 0de355bffcabb005be29adf - count: '75.45' value: 0de3564ffcabb005be29b2a - count: '79.64' value: 0de3564ffcabb005be29b2b - count: '83.83' value: 0de3564ffcabb005be29b36 - count: '86.83' value: 0de3564ffcabb005be29b3b - count: '89.82' value: 0de3564ffcabb005be29b3c - count: '92.81' value: 0de3564ffcabb005be29b47 - count: '95.21' value: 0de3564ffcabb005be29b4c - count: '97.60' value: 0de3564ffcabb005be29b4d - count: '100.00' value: 0de3564ffcabb005be29b58 '400': description: Bad request '401': description: Unauthorized '500': description: Internal server error servers: - url: https://multiple-question-analysis.sightx.io components: securitySchemes: AuthorizationHeader: type: apiKey in: header name: Authorization description: Access token obtained from the m2m-token endpoint. ````