Datsy-API is a free, open and simple API to access and explore an ever growing number of data sets.
When you run grunt from the command line, the following will happen after each
file save:
- lint your changes and display any errors
- run all unit tests within
test/and display any errors
Run grunt dev to do the following:
- connect to a development PostgreSQL database on
localhost - run nodemon with the
--debugsetting
Run grunt prod to do the following:
- connect to a production PostgreSQL database based on the information in the config file
- run nodemon with the
--debugsetting
| Name | Required | Description |
|---|---|---|
tag |
Optional | The tags to be searched for |
GET /search/tag
Returns object with two fields:
- tag: array of all tags attached to tables
- total: total number of tables relating to the tags
{
tag: ["san francisco", "technology", "stock", "weather", "fitbit", "ufo"],
total: 9
}
- Queries can contain one or more
tagnames; - Punctuation is removed from the search.
GET /search/tag?tag=<tagname>
GET /search/tag?tag=<tagname>&tag=<anotherTagname>
Returns object with two fields:
- total: return the total number of tables that contains the tag;
- tag: return all the tags in the tables;
Response to:
http://datsy-dev.azurewebsites.net/search/tag?tag=san+francisco
Returned:
{
"tag": [
"daily",
"san francisco",
"weather",
"temperature",
"fitbit",
"health",
"exercise",
"fitness",
"public policy",
"lobbying",
"lobbyists"
],
"total": 3
}
Response to:
http://datsy-dev.azurewebsites.net/search/tag?tag=San+Francisco&tag=lobbying
Returned:
{
"tag": [
"san francisco",
"public policy",
"lobbying",
"lobbyists"
],
"total": 1
}
Returns metadata for all tables, including column metadata.
| Name | Required | Description |
|---|---|---|
tag |
Optional | The tags to be searched for |
GET search/meta
Returns an array of JSON objects, each representing the metadata for a table in the database. MetaData object also include column information.
Response to:
http://datsy-dev.azurewebsites.net/search/meta
Returned:
[
{
"table_name": "samsung_stock",
"user_id": 5,
"url": "www.yahoo.com",
"title": "samsung stock",
"description": "samsung stock data",
"author": "Yahoo finance",
"created_at": "2013-12-06T22:22:49.000Z",
"last_access": null,
"view_count": null,
"star_count": null,
"row_count": 786,
"col_count": 7,
"last_viewed": null,
"token": null,
"id": 1,
"columns": [
{
"name": "Date",
"description": "Date",
"data_type": "Date"
},
{
"name": "Open",
"description": "Open",
"data_type": "String"
}
]
},
{
"table_name": "samsung_stock",
"user_id": 5,
"url": "www.yahoo.com",
...
}
]
GET search/meta?tag=<tagname>
- returns metadata, including column information, of tables associated with the
tagname.
Response to:
http://datsy-dev.azurewebsites.net/search/meta?tag=technology
Returned:
[
{
"table_name": "samsung_stock",
<!-- other property saved in the metadata table -->
"columns": [
{
"name": "Date",
"description": "Date",
"data_type": "Date"
},
{
"name": "Open",
"description": "Open",
"data_type": "String"
}
]
},
<!-- more tables if applicable -->
]
| Name | Required | Description |
|---|---|---|
name |
Required | The name of table to be queried |
column |
Optional | The column name, if not specified, return all columns in the table |
row |
Optional | The number of rows retrieved, if not specified, return the first 5 rows in the table; use 'ALL' to get all rows |
GET search/table?name=<tablename>
Returns a JSON object tableMeta: metadata of the table named rows: by default, return the first 5 rows of all columns
Response to:
http://datsy-dev.azurewebsites.net/search/table?name=lobbyist_activity
Returned:
{"Result":
{"tableMeta":
{"table_name":"lobbyist_activity"
<!-- other property saved in the metadata table -->
},
"row":[
{"Date":"2010-01-01 00:00:00+00",
"Visit Count":1,
"id":1
},
{<!-- the next four rows of data -->}
]
}
}
GET search/table?name=<tablename>&column=<columnname>
Returns a JSON object.
tableMeta: metadata of the table named rows:By default, return the first 5 rows of the specified column
Response to:
http://datsy-dev.azurewebsites.net/search/table?name=lobbyist_activity&column=Date
Returned:
{"Result":
{"tableMeta":
{"table_name":"lobbyist_activity"
<!-- other property saved in the metadata table -->
},
"row":[
{"Date":"2010-01-01 00:00:00+00"},
{"Date":"2010-01-04 00:00:00+00"},
{"Date":"2010-01-05 00:00:00+00"},
{"Date":"2010-01-06 00:00:00+00"},
{"Date":"2010-01-07 00:00:00+00"}
]
}
}
Note: multiple "column" can be selected (see example 3).
GET search/table?name=<tablename>&column=<columnname>&row=<numberofrow>
Returns a JSON object.
tableMeta: metadata of the table named rows:By default, return the first 5 rows of the specified column
Example 1:
http://datsy-dev.azurewebsites.net/search/table?name=lobbyist_activity&column=Date&row=10
Returned:
{"Result":
{"tableMeta":
{"table_name":"lobbyist_activity"
<!-- other property saved in the metadata table -->
},
"row":[
{"Date":"2010-01-01 00:00:00+00"}
<!-- first 10 rows of the 'Date' column -->
]
}
}
Example 2:
http://datsy-dev.azurewebsites.net/search/table?name=lobbyist_activity&column=Date&row=ALL
Returned:
{"Result":
{"tableMeta":
{"table_name":"lobbyist_activity"
<!-- other property saved in the metadata table -->
},
"row":[
{"Date":"2010-01-01 00:00:00+00"}
<!-- All rows of the 'Date' column -->
]
}
}
Example 3:
http://datsy-dev.azurewebsites.net/search/table?name=lobbyist_activity&column=Date&column=Visit+Count