GET
/
api
/
v1
/
reports
/
{id}
/
text_entries
/
Text Entries
curl --request GET \
  --url https://api.main.apexscore.ai/api/v1/reports/{id}/text_entries/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "text": "<string>",
      "entry": {
        "response_id": "<string>",
        "metadata": {}
      },
      "sentiment_overall": "positive",
      "topics": "<string>",
      "starred": true,
      "text_violation_flag": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

A UUID string identifying this report.

Query Parameters

​
attitude_names
string[]

List of attitude names to filter by. Case-insensitive.

​
configuration_id
string

Optional configuration id to retrieve. If not provided, the primary configuration will be used.

​
only_analyzed
boolean
default:true

Only return analyzed text entries (where ref is not null).

​
page
integer

A page number within the paginated result set.

​
per_page
integer

Number of results to return per page.

​
sentiment
enum<string>
Available options:
any,
negative,
neutral,
positive
​
starred
boolean

Filter by starred status.

​
text_violation_flag
boolean

Set to true to include entries with a text violation flag. By default, entries with a text violation flag are excluded.

​
topic_ids
string[]

Topic ids to filter by. Get applicable topic ids from the summary/topics endpoint.

Response

200 - application/json

The response is of type object.