Returns KPI rows extracted from a filing, including segment and companywide rows, period identity, and a page-linked PDF URL when page mapping is available.
| Name | Description | Example |
|---|---|---|
|
identifier
* required
|
A Filing identifier | fil_B73xBG |
|
end_date
|
Return KPI rows for the given period end date. | - |
|
series_kind
|
Filter by series type. Use `companywide` or `segment`; comma-separated values are supported.
Options:
companywide
segment
show more
show less
|
- |
|
kpi_type
|
Filter by KPI type. Use `financial` or `operational`; comma-separated values are supported.
Options:
financial
operational
show more
show less
|
- |
|
segment_type
|
Filter by segment type; comma-separated values are supported. | - |
|
metric_form
|
Filter by metric form; comma-separated values are supported. | - |
|
accounting_basis
|
Filter by accounting basis; comma-separated values are supported. | - |
|
dimension_kind
|
Filter by dimension kind; comma-separated values are supported. | - |
|
dimension_value
|
Filter by dimension value; comma-separated values are supported. | - |
|
identifier
* required
A Filing identifier
|
||
|
end_date
* required
Return KPI rows for the given period end date.
|
||
|
series_kind
* required
Filter by series type. Use `companywide` or `segment`; comma-separated values are supported.
|
||
|
kpi_type
* required
Filter by KPI type. Use `financial` or `operational`; comma-separated values are supported.
|
||
|
segment_type
* required
Filter by segment type; comma-separated values are supported.
|
||
|
metric_form
* required
Filter by metric form; comma-separated values are supported.
|
||
|
accounting_basis
* required
Filter by accounting basis; comma-separated values are supported.
|
||
|
dimension_kind
* required
Filter by dimension kind; comma-separated values are supported.
|
||
|
dimension_value
* required
Filter by dimension value; comma-separated values are supported.
|
| Name | Description | Type |
|---|---|---|
| kpis | array | |
|
label
|
string | |
|
value
|
number | |
|
table_header
|
string | |
|
period_end_date
|
date | |
|
fiscal_period_label
|
string | |
|
months
|
integer | |
|
fiscal_year
|
integer | |
|
fiscal_quarter
|
integer | |
|
series_kind
|
select | |
|
kpi_type
|
select | |
|
dimension_kind
|
string | |
|
dimension_value
|
string | |
|
pdf_url
|
string | |
| filing | object | |
|
id
|
The Intrinio ID of the Filing | string |
|
filing_date
|
The date when the filing was submitted to the SEC by the company | date |
|
accepted_date
|
The date and time when the filing was accepted by SEC | string |
|
period_end_date
|
The ending date of the fiscal period for the filing | date |
|
report_type
|
The filing report type | string |
|
sec_unique_id
|
A unique identifier for the filing provided by the SEC | string |
|
filing_url
|
The URL to the filing page on the SEC site | string |
|
report_url
|
The URL to the actual report on the SEC site | string |
|
instance_url
|
The URL for the XBRL filing for the report | string |
|
kpis
|
||
|
filing
|