Skip to main content
GET
/
data-quality
Data quality review queues
curl --request GET \
  --url https://mkk.celebi.me/api/data-quality
{
  "scope": {
    "fund_id": "<string>"
  },
  "limits": {
    "list_limit": 123,
    "low_line_item_threshold": 123
  },
  "summary": {
    "documents": 123,
    "documents_with_line_items": 123,
    "documents_with_portfolio": 123,
    "documents_with_both": 123,
    "portfolio_only_documents": 123,
    "empty_documents": 123,
    "low_line_item_documents": 123,
    "review_mappings": 123,
    "numeric_parse_failures": 123,
    "portfolio_numeric_parse_failures": 123,
    "missing_pdfs": 123
  },
  "mapping_methods": [
    {
      "mapping_method": "<string>",
      "value_count": 123,
      "avg_confidence": 123
    }
  ],
  "low_line_item_documents": [
    {
      "id": 123,
      "disclosure_index": "<string>",
      "file_name": "<string>",
      "fund_code": "<string>",
      "period": "<string>",
      "line_item_value_count": 123,
      "line_item_count": 123,
      "section_count": 123,
      "portfolio_entry_count": 123,
      "portfolio_row_count": 123
    }
  ],
  "portfolio_only_documents": [
    {
      "id": 123,
      "disclosure_index": "<string>",
      "file_name": "<string>",
      "fund_code": "<string>",
      "period": "<string>",
      "line_item_value_count": 123,
      "line_item_count": 123,
      "section_count": 123,
      "portfolio_entry_count": 123,
      "portfolio_row_count": 123
    }
  ],
  "empty_documents": [
    {
      "id": 123,
      "disclosure_index": "<string>",
      "file_name": "<string>",
      "fund_code": "<string>",
      "period": "<string>",
      "line_item_value_count": 123,
      "line_item_count": 123,
      "section_count": 123,
      "portfolio_entry_count": 123,
      "portfolio_row_count": 123
    }
  ],
  "review_mappings": [
    {
      "id": 123,
      "document_id": 123,
      "disclosure_index": "<string>",
      "file_name": "<string>",
      "fund_code": "<string>",
      "period": "<string>",
      "section_name": "<string>",
      "line_item_slug": "<string>",
      "line_item_name": "<string>",
      "raw_section": "<string>",
      "raw_label": "<string>",
      "value": "<string>",
      "mapping_method": "<string>",
      "mapping_confidence": 123
    }
  ],
  "numeric_parse_failures": [
    {
      "id": 123,
      "document_id": 123,
      "disclosure_index": "<string>",
      "file_name": "<string>",
      "fund_code": "<string>",
      "period": "<string>",
      "line_item_slug": "<string>",
      "line_item_name": "<string>",
      "raw_label": "<string>",
      "value": "<string>"
    }
  ],
  "portfolio_numeric_parse_failures": [
    {
      "id": 123,
      "document_id": 123,
      "disclosure_index": "<string>",
      "file_name": "<string>",
      "fund_code": "<string>",
      "fund_title": "<string>",
      "period": "<string>",
      "section": "<string>",
      "security": "<string>",
      "isin": "<string>",
      "issuer": "<string>",
      "bank": "<string>",
      "maturity_date": "<string>",
      "transaction_date": "<string>",
      "price": "<string>",
      "numeric_price": 123,
      "transaction_value": "<string>",
      "numeric_transaction_value": 123,
      "nominal_value": "<string>",
      "numeric_nominal_value": 123,
      "market_value": "<string>",
      "numeric_market_value": 123,
      "rate": "<string>",
      "numeric_rate": 123,
      "amount": "<string>",
      "numeric_amount": 123,
      "currency": "<string>",
      "raw_row": "<string>",
      "columns": [
        {
          "header": "<string>",
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "failed_fields": [
        "<string>"
      ]
    }
  ],
  "missing_pdfs": [
    {
      "id": 123,
      "disclosure_index": "<string>",
      "file_name": "<string>",
      "fund_code": "<string>",
      "period": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.mkk.celebi.me/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

fund_id
string

Filter by fund code.

fund_code
string

Filter by fund code.

limit
integer

Maximum number of rows to return.

Required range: 1 <= x <= 500
low_line_item_threshold
integer

Line-item value count below which a document enters the low-coverage queue.

Required range: 0 <= x <= 100

Response

200 - application/json

Read-only data quality summary and review queues.

scope
object
limits
object
summary
object
mapping_methods
object[]
low_line_item_documents
object[]
portfolio_only_documents
object[]
empty_documents
object[]
review_mappings
object[]
numeric_parse_failures
object[]
portfolio_numeric_parse_failures
object[]
missing_pdfs
object[]