Indicator Descriptions
Returns data from the [descriptions] table.
This table provides the metadata that describes the entire dataset. It includes details for all the indicators available in each table including the title, name, description, unit type and whether or not the indicator acts as a primary key or filter on the table.
In addition, this table includes the details for each action corresponding to the actions codes in the [actions] tables.
For more information on the dataset and the available indicators, please review the descriptions table on the Data Explorer page.
The table is queried via the following endpoint
https://api.findl.com/v1.0/data/descriptions?apiKey=test-api-keyThe queries are authenticated and filtered using query parameters. A query parameter specifies a particular option or filter for the data to be returned. Examples of query parameter include the data format to be returned (format), the table columns to return (fields) or a filter to be applied (tablename). These are appended to the endpoint above, following a ?. The most important of these is your API key (apiKey) which is used to authenticate you. Without a valid API key, results will not be returned.
The descriptions table supports the following query parameters.
| Parameter | Description | Default | Examples |
|---|---|---|---|
| format | The format of the results to be returned. | csv | format=json |
| fields | The fields (table columns) to return. | all | fields=tablename,indicator,description |
| tablename | The table to return descriptions for. | all | tablename=fundamentals |
| limit | The number of records to return. | 10000 | limit=100000 |
| skip | The number of results to skip before returning data. | 0 | skip=10000 |
| sort | The field used to sort the data and the sort method (asc/desc). | date.desc | sort=indicator.asc |
| indicator | The the indicator to return data for. | all | indicator=revenue |
Return the the indicator details for all tables in the dataset
https://api.findl.com/v1.0/data/descriptions?apiKey=test-api-key&format=csvReturn the indictors and descriptions for a specific table (e.g. fundamentals)
https://api.findl.com/v1.0/data/descriptions?apiKey=test-api-key&format=csv&tablename=fundamentalsReturn the details for a single indicator on a table (e.g. the revenue indicator on the fundamentals table)
https://api.findl.com/v1.0/data/descriptions?apiKey=test-api-key&format=csv&tablename=fundamentals&indicator=revenueCopyright © findl 2024. All rights reserved.