Feedback Dataset search endpoint

[gabrielmbmb]

Create a new search endpoint POST /api/v1/me/datasets/{dataset_id}/records/search allowing to search records using the search function introduced in #3037.

Input

The input payload of the endpoint will be for searching in all the fields of the dataset:

{
  "query": {
    "text": { "q": "bad" }
  }
}

Input payload for searching in a specific field:

{
  "query": {
    "text": { "q": "bad", "field": "text" }
  }
}

Additionally, the following query parameters could be provided:

• include: to specify which additional information has to be included in the output (like the responses)
• response_status: to filter the results based on the response status

Output

{
  "items": [
    {
      "record": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "fields": {},
        "external_id": "string",
        "responses": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "values": {
              "question-1": {
                "value": "string"
              },
              "question-2": {
                "value": "string"
              },
              "question-3": {
                "value": "string"
              }
            },
            "status": "draft",
            "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "inserted_at": "2023-06-02T14:42:30.335Z",
            "updated_at": "2023-06-02T14:42:30.335Z"
          }
        ],
        "inserted_at": "2023-06-02T14:42:30.335Z",
        "updated_at": "2023-06-02T14:42:30.335Z"
      },
      "query_score": 14.234
    }
  ]
}