Retrieve detailed information for evaluation carriers (supports target by id).
POST/api/v1/survey/:surveyCode/evaluation
This method retrieves detailed data for a specific evaluation, represented as a two-dimensional data slice.
A Evaluation is structured by two main dimensions: ROWS and COLUMNS. These dimensions contain one axis (containers for carriers or statistical elements). The full data cube represents the combination of all items across all axes in all three dimensions.
the ROWS, COLUMNS dimensions.
Response Body Structure
The response contains two main sections: dimensions (the metadata) and matrix (the data slice).
Dimensions (Metadata)
The dimensions array explains how the tabulation is structured:
-
ROWS – Defines all plans with row carriers. Example items: Axis 1: PLAN_TOTAL, ABC, ARA, ATLANTICODIARIO, PLAN_1, ABC, ARA, ATLANTICODIARIO.
-
COLUMNS – Defines all column statistics on carriers. Example items: Axis 2: INSERTIONS, CONTACT, GRP, COVER, COVER_PERCENT.
Matrix Representation (Data Slice)
The matrix array holds the actual data. Since this endpoint returns a single 2D slice, the array will contain one object.
- matrix[].table: A two-dimensional array of numeric values. Each value is the result of a unique intersection point from the two dimensions.
Data Mapping and Traversal
The values in matrix[].table are ordered according to the items in the ROWS dimension (outer array) and COLUMNS dimension (inner array) combination.
Consumers must traverse the table in the following order to correctly map data points back to the dimensions:
-
ROWS – (First Index [r]): The outer array index (row) corresponds to a specific item from the ROWS dimension.
-
COLUMNS - (Second Index [c]): The inner array index (column) corresponds to a specific item from the COLUMNS dimension.
Example Mapping
This demonstrates how a cell value is mapped to the full 2D coordinates, using the example data :
| Cell Index | Value | Corresponding Data Point |
|---|---|---|
| table[0][0] | 10 | {ROW: PLAN_TOTAL, COLUMN: INSERTIONS} |
| table[1][0] | 2 | {ROW: ABC, COLUMN: INSERTIONS} |
| table[2][0] | 5 | {ROW: ARA, COLUMN: INSERTIONS} |
| table[3][0] | 3 | {ROW: ATLANTICODIARIO, COLUMN: INSERTIONS} |
| table[4][0] | 5 | {ROW: PLAN_1, COLUMN: INSERTIONS} |
| table[5][0] | 2 | {ROW: ABC, COLUMN: INSERTIONS} |
| table[6][0] | 2 | {ROW: ARA, COLUMN: INSERTIONS} |
| table[7][0] | 1 | {ROW: ATLANTICODIARIO, COLUMN: INSERTIONS} |
| table[8][0] | 5 | {ROW: PLAN_2, COLUMN: INSERTIONS} |
| table[9][0] | 2 | {ROW: ABC, COLUMN: INSERTIONS} |
| table[10][0] | 1 | {ROW: ARA, COLUMN: INSERTIONS} |
| table[11][0] | 2 | {ROW: ATLANTICODIARIO, COLUMN: INSERTIONS} |
Symmetric to Ranking: supports target.id (by-id resolution across visible workspaces) or target.filterTgl (inline).
Result is NOT persisted. Use POST /survey/{surveyCode}/evaluation/save/{workspaceId} to save.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Evaluation Carriers retrieved successfully
Bad Request. The request parameters are invalid.
Unauthorized. Missing or invalid API key.
Forbidden. The API key does not grant access to workspaces.
Not Found. The requested resource was not found.
Internal Server Error. Unexpected error occurred while processing the request.