Data Product Serving API
The APIs under this category help serve data to users of subscribed data products. The general syntax of apis are as - "Rest Verb" "Base URL or Host URL"/"API Version"/"Data Product Identity Code"/"Rest Endpoint" Below are detailed descriptions of some APIs. Users of data Product APIs are highly encouraged to follow the sequence of APIS as below to understand most about any Data Product. These APIs also support any complex context building around Data Product. Some generic context building around every Data Product includes Space, Time, Geo Location, Region, Country or Administrative or Sub-Administrative Locality. For Users this is simply key value pair matching to arrive at any subsection of data and lead analysis further. The key value pair can be supplied via simple url query params or payload with context objects.
| METHOD | ENDPOINT | USAGE |
|---|---|---|
| GET | {{baseUrl}}/{{version}}/{{DP Code}}/apis |
This apis endpoint serves API documentation for specific Data Product. The documentation does follow Open Source Swagger Documentation Standard V2.0. E.gGET https://platform.taiyo.ai/taiyoserve/v1/sam_gov/apisthis api call serves detailed documentation about every API available under DataProduct which serves data for Sam.gov. |
| GET | {{baseUrl}}/{{version}}/{{DP Code}}/description |
This description endpoint serves detailed textual description of Data Product, its origin sources and more. This description also sets as a starting point to understand what data available under this data product code. |
| GET | {{baseUrl}}/{{version}}/{{DP Code}}/schema |
This schema endpoint serves the schema of Data Product, its attribute list, types and description. This schema helps understand how data is stored and organized. For analysts this endpoint helps to understand what all dimensions of data are available to lead their analysis. |
| GET | {{baseUrl}}/{{version}}/{{DP Code}}/metadata |
This metadata endpoint serves the medata around the Data Product. It mainly contains information like - When was the last time this data product synched with sources? What is the latest and oldest information available under it? What version of Data Product user is referring to? What are summary stats around Data Product and key attributes? |
| GET | {{baseUrl}}/{{version}}/{{DP Code}}/get |
This get endpoint serves the sample or full data of Data Product in json, csv and csv streaming format. This sample data helps build understanding of data along with schema.Users are encouraged to fetch samples first and cross verify their understanding of attributes, schemas with actual data under each attribute. |
| GET | {{baseUrl}}/{{version}}/{{DP Code}}/ref_dictionary |
This ref_dictionary endpoint serves the reference dictionary or distinct values under one or more attributes. Any number of nested attributes reference dictionaries can be built to understand available data or depth of data under these dimensions for analysts. Also these can be used as reference checks and future joins if required with data systems. |
| GET | {{baseUrl}}/{{version}}/{{DP Code}}/timeseries |
This timeseries endpoint serves aggregated reference to values or observations within Data Product with respect to timeline. Values and Timeline support Aggregation with respect to ranges of time or categories of numbers. This timeseries API also supports complex context around it so users can get an understanding of data availability with time. |
| GET | {{baseUrl}}/{{version}}/{{DP Code}}/aggs |
This aggs endpoint supports aggregation of data across all attributes available under specific Data Product. The aggregation with context selected helps summarize data and see that specific sub section. |
| GET | {{baseUrl}}/{{version}}/{{DP Code}}/otherassets |
This otherassets endpoint serves all static assets available with specific Data Product like icons, if any summary report files, etc. |
| GET | {{baseUrl}}/{{version}}/{{DP Code}}/dataflow |
This dataflow endpoint gives technical information about how data flows from our strategic sources till APIs or UI. |
| GET | {{baseUrl}}/{{version}}/{{DP Code}}/modules |
This modules endpoint gives technical information about what all steps we perform while sourcing/screping data from our sources. Descriptions about different modules and tasks they achieved can be seen with modules endpoint. |