extract

GET /api/v1/extract/date-usage/

Date Usage List

GET params:

document_id: int
date_search: str
month_search: str ('%Y-%m-%d')

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/extract/date-usage/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

datestring date required

countinteger

pkinteger

text_unit__pkstring

text_unit__unit_typestring

text_unit__location_startstring

text_unit__location_endstring

text_unit__document__pkstring

text_unit__document__namestring

text_unit__document__descriptionstring

text_unit__document__document_typestring

Example response

[
  {
    "date": "2000-01-23",
    "text_unit__document__description": "text_unit__document__description",
    "text_unit__location_end": "text_unit__location_end",
    "text_unit__document__pk": "text_unit__document__pk",
    "count": -1803530559,
    "text_unit__pk": "text_unit__pk",
    "pk": 6,
    "text_unit__unit_type": "text_unit__unit_type",
    "text_unit__location_start": "text_unit__location_start",
    "text_unit__document__name": "text_unit__document__name",
    "text_unit__document__document_type": "text_unit__document__document_type"
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.