Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
analyze
v1

Document Cluster List

get/api/v1/analyze/document-cluster/

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
documents_countinteger

Example response

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