GET Findings/{InspectionKey}
Gets information about the findings in an Inspection.
Because an Inspection may contain a very large number of findings they are returned one partition at a time.
Each partition contains a number of findings that allow for a manageable payload size.
To retrieve all of the findings in an Inspection, first use this operation to retrieve the number of topic and sentiment partitions in the Inspection,
then query for each partition using the
GET /Findings/Topics/{PartitionIndex} and
GET /Findings/Sentiment/{PartitionIndex}
operations.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| InspectionKey |
The key of the Inspection. |
integer |
Required |
Body Parameters
None.
Response Information
Gets information about the findings in an Inspection.
Because an Inspection may contain a very large number of findings they are returned one partition at a time.
Each partition contains a number of findings that allow for a manageable payload size.
To retrieve all of the findings in an Inspection, first use this operation to retrieve the number of topic and sentiment partitions in the Inspection,
then query for each partition using the
GET /Findings/Topics/{PartitionIndex} and
GET /Findings/Sentiment/{PartitionIndex}
operations.
| Name | Description | Type | Additional information |
|---|---|---|---|
| TopicPartitions |
The number of partitions of topic findings in the Inspection. |
integer |
Required |
| TopicFindings |
The total count of topic findings in the Inspection. |
integer |
Required |
| SentimentPartitions |
The number of partitions of sentiment findings in the Inspection. |
integer |
Required |
| SentimentFindings |
The total count of topic sentiment in the Inspection. |
integer |
Required |
| errors |
If null the request was processed without error. If not null errors occurred while processing the request. The array contains the error messages. |
Collection of string |
None. |