Get extraction statistics

Returns daily extraction coverage statistics per config. Sensible returns coverage for each config that was used for at least one extraction performed in the production environment in the specified time period. For more information about coverage, see Monitoring extractions.

Authorizations

Authorization

string

header

required

Sensible uses API keys to authenticate requests. Keep your API keys secure and do not share them publicly accessible areas such as GitHub, client-side code, etc. Authentication to the API is performed via Bearer Authentication. Provide your API key as the bearer auth value.

Query Parameters

start_date

string

required

Retrieves statistics for configs used in production on this day and later. Sensible returns daily statistics, so if you specify a time in addition to a date, Sensible ignores the time.

end_date

string

required

Retrieves daily statistics for configs used in production on this day and earlier.

Response

200

application/json

Returns daily statistics for configs in the specified time period.

statistics

object[]

Show child attributes

statistics.date

string

The day for which Sensible gets statistics for this config.

statistics.configuration_id

string

ID of the "configuration", a collection of SenseML queries for extracting document data.

Example:

"24d82783-c12b-4e70-b0ae-ca1ce35a98"

statistics.configuration_name

string

Name of the "configuration", a collection of SenseML queries for extracting document data.

Example:

"config_for_x_company"

statistics.document_type_id

string

Unique user-friendly name for a document type

Example:

"11c82772-a12c-1e71-c0a1-1f1ce35bc7"

statistics.document_type_name

string

Unique user-friendly name for a document type

Example:

"auto_insurance_quotes_all_carriers"

statistics.coverage_histogram

integer[]

Array of numbers that describe the number of extractions that fell into each coverage bucket for the date for this config. The buckets are as follows:

• [0, 10)
• [10, 20)
• [20, 30)
• [30, 40)
• [40, 50)
• [50, 60)
• [60, 70)
• [70, 80)
• [80, 90)
• [90, 95)
• [95, 100)
• [100]

[ denotes inclusive and ) denotes exclusive. For example, when this endpoint returns "coverage_histogram":[7,5,3,3,2,1,1,4,7,9,13,15] , the first and last items in the array show that on specified date for the specified config, 7 extractions scored in the lowest bucket of 0-10%, and 15 scored in the highest bucket of 100%. For more information about extraction coverage scores, see Monitoring extractions. From the payload returned by this endpoint, you can calculate other metrics, for example:

• total number of extractions in a time period
• doc type and config usage

Example:

[1, 3, 5, 4, 6, 5, 3, 7, 8, 2, 4, 9]