analyze

GET /api/v1/analyze/text-unit-cluster/list/

Changed on May 24, 2021

Text Unit Cluster List

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/analyze/text-unit-cluster/list/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

jq_filtersobject

Filter params similar to JQWidgets grid filter params: filterscount=1, filterdatafield0="a", filtervalue0="b", filtercondition0="CONTAINS", filteroperator0=1, sortdatafied="c", sortorder="asc"

Response

pkinteger

cluster_idinteger

namestring required

self_namestring required

descriptionstring required

cluster_bystring required

usingstring required

created_datestring date-time

text_unit_countinteger

text_unit_dataobject[]

Example response

[
  {
    "cluster_id": 441289069,
    "using": "using",
    "name": "name",
    "description": "description",
    "text_unit_count": 1,
    "text_unit_data": [
      "{}",
      "{}"
    ],
    "pk": 0,
    "created_date": "2000-01-23T04:56:07.000+00:00",
    "self_name": "self_name",
    "cluster_by": "cluster_by"
  }
]

Changes

May 24, 20218167164be9cc Revision changes
- breaking
  the / response's property type changed from string to integer for status
- breaking
  the / response's property type changed from string to array for status
Dec 11, 20200957c4a7ae3d Revision changes
- breaking
  the / response's property type changed from integer to string for status
- breaking
  the / response's property type changed from array to string for status

Operation history