/api/facttable-for-report

GET

Retrieve the fact table for a given report. Filters can be overriden. Filters MUST be overriden if the report is not already filtering.

Parameters

Name Type Description Profile
profile-name query Specifies which profile to use, which will enable some parameters or modify hypercube queries accordingly. The default depends on the underlying repository  
format query Returns the results in the supplied format  
format-indent query Whether or not to indent JSON or XML output (default: no indent).  
token query The token that allows you to use this API. Gives you read (GET) and/or write (POST, DELETE, PATCH) credentials.  
aid query Archive IDs, to retrieve archives, sections, components or slice facts.  
eid query The EIDs (scheme + local name) of a company, to retrieve entities, archives, sections, components or dice facts.  
cik query The CIK of a company, to retrieve entities, archives, sections, components or dice facts. sec
ticker query The ticker of a company, to retrieve entities, archives, sections, components or dice facts. sec, japan
edinetcode query The EDINET code of a company, to retrieve entities, archives, sections, components or dice facts. japan
entity-tag query The tag of an entity (such as an index), to retrieve entities, archives, sections, components or dice facts. sec, japan
sic query The SIC (industry group) of a company, to retrieve entities, archives, sections, components or dice facts. sec
concept query The name of a concept to dice facts (a synonym for the dimension xbrl:Concept).  
fiscalYear query A fiscal year to slice facts (a synonym for the dimension xbrl28:FiscalYear, default: no filtering). sec, japan
fiscalPeriod query A fiscal period to slice facts (a synonym for the dimension xbrl28:FiscalPeriod, default: no filtering). sec, japan
fiscalPeriodType query A fiscal period type to slice facts (a synonym for the dimension xbrl28:FiscalPeriodType, default: no filtering). sec, japan
archiveFiscalYear query The fiscal year focus of the archive, to retrieve archives, sections, components or slice facts (default: ALL). sec, japan
archiveFiscalPeriod query The fiscal period focus of the archive, to retrieve archives, sections, components or slice facts (default: ALL). sec, japan
open query Whether the hypercube query has open hypercube semantics, i.e., automatically stretches to accommodate for all found dimensions (default: false).  
report query The report to use as a context to retrieve the facts. In particular, concept maps and rules found in this report will be used. (default: none).  
labels query Whether human-readable labels should be included for concepts in each fact (default: false).  
metadata query Whether metadata about the facts concept and dimensions should be included in each fact (default: false).  
audit-trails query Whether audit trails should be included in each fact (default: no).  
language query A language code (default: en-US) for displaying labels.  
aggregation-function query Specify an aggregation function to aggregate facts. Will aggregate facts, grouped by dicers, but aggregated along slicers, with this function.  
validate query Whether or not to stamp facts for validity (default is false).  
override query Whether the static component or report hypercube should be tampered with using the same hypercube-building API as the facts endpoint (default: true if a profile is active, otherwise automatically activated).  
count query If true, only outputs statistics (default: false).  
top query Output only the first [top] results (default: no limit).  
skip query Skip the first [skip] results.  

Status codes

Code Description
200 Return the fact table for the given component
401 Unauthorized: the specified project token is invalid, expired, or has insufficient privileges
404 No such entity could be found. / No such archive could be found
500 An internal error occurred during the processing of the request