Glossary#
The new data infrastructure product uses the following terms, ordered alphabetically.
API#
Stands for Application Programming Interface. You can interact with software programmatically via its API. IEX Cloud provides an Apperate API Reference and API tutorials. The tutorials are here in the docs site.
CSV#
Stands for Comma Separated Value. It is a text format for specifying data using rows and columns. The first row’s values describe each column. Each subsequent row represents an instance of the data, including values (in some cases empty values) for each column.
See also
Load Data from a File demonstrates importing data from a CSV file.
Data Bundle#
A permissioned aggregation of datasets, focused around a common topic. You can purchase a license for the data bundles that suit your needs.
See also
The Data Bundles section introduces each data bundle.
Data Source#
A source from which data is ingested into Apperate.
The following tutorials demonstrate using data sources:
Data Timing#
The typical frequency of new data being produced for an entity (e.g., stock price, company dividends, etc.). A core data endpoint doc’s Data Timing section describes the new data frequency for the respective entity. For examples, see the Data Timing section of any dataset endpoint listed in IEX Cloud Data navigation in the API reference.
Dataset#
A modifiable data collection (or table) that is defined by a schema, stored in IEX Cloud Apperate, and delivered via permissioned, auto-generated APIs.
See these articles to understand datasets and learn how to use them:
Date Index#
Designates the time series index portion of a dataset’s Unique Index.
See also
Ingest (Ingest data)#
To load data into a dataset.
See also
Ingestion Schedule#
A timetable, set by the user, to automatically ingest data from a given data source into IEX Cloud.
See also
Job (Data Job)#
A data-processing instance. There are jobs for ingesting, modifying, and deleting data.
See also
JSON#
Stands for JavaScript Object Notation. It is a text format for specifying objects.
Primary index#
A property that serves as a record’s main identifier.
See also
Publishable Token (Publishable Key)#
All tokens, including publishable tokens, allow you to execute requests and access specific console pages and specific Apperate API reference pages. Publishable tokens can have core dataset read access and have read, write, and / or delete permissions for any private datasets. Subscribers can create and share publishable tokens to grant access to specific datasets; tokens have core dataset read access by default. Your tokens are available in the Console here.
See also
Token and Access and Security.
Secondary index#
A property that serves as an identifier that’s used in addition to the Primary index.
See also
Secret Token (Secret Key)#
Registered accounts have a secret token (aka secret key). A secret token (aka secret key) allows you perform any action on your data or account. NEVER share your secret token publicly. Paid accounts can create and share publishable tokens to grant access to specific data endpoints. Your secret token is available in the Console here.
See also
Token and Access and Security.
SmartLink#
A mapping of a dataset property to Apperate’s financial metadata graph. This mapping associates the property’s values with equivalent values that use any of Apperate’s supported financial identifiers.
A dataset’s SmartLinks enable you to query on or join other datasets on the associated property using any equivalent financial identifier type values.
See also
See Normalized Financial Symbols for examples of querying on and joining datasets on SmartLinked properties.
Storage Amount (Plan Storage Amount)#
The amount of data an Apperate plan includes.
Storage credit usage is based on your plan’s Storage Amount and is calculated and reported hourly as the STORAGE_ON_DISK endpoint’s Credits Used.
Important
You cannot exceed your plan’s Storage Amount. Apperate blocks any attempt to exceed the Storage Amount. You must upgrade your plan (see your the Manage Plan page) to store more data.
Token (API Token)#
An token (aka API token) allows you to execute requests and access specific console pages and Apperate API reference pages. Tokens have read, write, and/or delete permissions for one or more API endpoints. Your tokens are available in the Console here.
Registered accounts have a secret token (aka secret key). This secret token allows you perform any action on your data or account. NEVER share your secret token publicly. Paid accounts can create and share publishable tokens to grant access to specific data endpoints.
See also
Unique Index#
A dataset’s main key composed of the Primary index, Secondary index (optional), and Date index.
See also
Update Schedules#
The regular times Apperate publishes new data to a core dataset. A core dataset endpoint doc’s Update Schedule section describes the publishing times. For examples, see the Update Schedule section of any endpoint listed in IEX Cloud Data navigation in the API reference.
View#
A virtual dataset created from a SQL query that joins multiple datasets.
See also
Workspace#
Your unique domain for building and publishing datasets. The URL format and example below show workspace names and dataset names in bold.
URL Format: https://workspace.iex.cloud/v1/data/WORKSPACE/DATASET
Example: https://my.iex.cloud/v1/data/MY/CARS
Note
Apperate displays your workspace name in the Console at the top left in your Home and at the top of Datasets navigation.
See also