\datasets\search

Description
This endpoint retrieves datasets from a search phrase, ranked by their relevance.
URL Structure
https://api.vay.studio/datasets/search
Method
POST
Body
search
The search phrase.

{
    "search": "Los Ang"
}
                
Headers
X-Auth-Token
Required. Your API Key.
Returns
result[i].id String
Id of the dataset.
result[i].sourceId String
Id of the source where the dataset was collected from.
result[i].title String
Title of the dataset.
result[i].link String
Internal link.
result[i].properties.desc String | Undefined
Information about the dataset.
result[i].properties.modified Number
Unix time in milliseconds of when the dataset was last modified.
result[i].properties.downloads[j].type String
The original format of the dataset.
result[i].properties.downloads[j].url String
The harvest url of the dataset.
result[i].properties.downloads[j].id String
The relative id of the dataset.
result[i].properties.downloads[j].properties.absoluteId String
The globally accessible id of the dataset.
result[i].properties.downloads[j].properties.cols String
Comma separated strings of the columns in the dataset
result[i].properties.downloads[j].properties.count String
The number of rows in the dataset.

{
    "errorCode": 0,
    "error": "",
    "result": [
        {
            "sourceId": "los-angeles",
            "id": "2010-census-populations-by-zip-code",
            "title": "2010 Census Populations By Zip Code",
            "link": "/sources/los-angeles/2010-census-populations-by-zip-code/",
            "properties": {
                "desc": "This data comes from the 2010 Census Profile of General Population and Housing Characteristics. Zip codes are limited to those that fall at least partially within LA city boundaries. The dataset will be updated after the next census in 2020. \nTo view all possible columns and access the data directly, visit http://factfinder.census.gov/faces/affhelp/jsf/pages/metadata.xhtml?lang=en&type=table&id=table.en.DEC_10_SF1_SF1DP1#main_content.",
                "modified": 1480464000000000000,
                "downloads": [
                    {
                        "type": "text/csv",
                        "url": "https://data.lacity.org/api/views/nxs9-385f/rows.csv?accessType=DOWNLOAD",
                        "id": "rows.csv",
                        "properties": {
                            "absoluteId": "los-angeles/2010-census-populations-by-zip-code/rows.csv",
                            "cols": "Total_Males,Average_Household_Size,Zip_Code,Total_Households,Total_Females,Total_Population,Median_Age",
                            "count": "319"
                        }
                    }
                ]
            }
        },
        {
            "sourceId": "los-angeles",
            "id": "2013-community-wide-greenhouse-gas-emissions",
            "title": "2013 Community-wide Greenhouse Gas Emissions",
            "link": "/sources/los-angeles/2013-community-wide-greenhouse-gas-emissions/",
            "properties": {
                "modified": 1556496000000000000,
                "downloads": [
                    {
                        "type": "text/csv",
                        "url": "https://data.lacity.org/api/views/fw6y-ht9f/rows.csv?accessType=DOWNLOAD",
                        "id": "rows.csv",
                        "properties": {
                            "absoluteId": "los-angeles/2013-community-wide-greenhouse-gas-emissions/rows.csv",
                            "cols": "CO2,GPC_ref_No_,CH4,Total_tCO2e,Sub_category,CO2_b_,GHG_Emissions_Source,Scope,Description_of_method_s__used_or_explanation_for_using_notation_key_s_,Sector,N2O,Notation__keys",
                            "count": "58"
                        }
                    }
                ]
            }
        }
    ]
}
            
vay logo

© Copyright 2019 Vay Technologies LLC.
All rights reserved.