observatory-extension/doc/api_docs.md

31 lines
832 B
Markdown
Raw Normal View History

2016-04-12 03:49:53 +08:00
# Data Observatory Access
This file is for reference purposes only. It is intended for tracking the Data Observatory API functions that should be displayed from the Docs site. Like all API doc, the golden source of the code will live in this repo. I will pull the list of files below into the docs for the output.
2016-04-12 03:56:01 +08:00
## Documentation
2016-04-12 03:49:53 +08:00
### OBS_GetSegmentationSnapshot
API Example:
2016-04-12 03:56:01 +08:00
```text
2016-04-12 03:49:53 +08:00
https://observatory.cartodb.com/api/v2/sql?q=SELECT%20*%20FROM%20OBS_GetSegmentationSnapshot(CDB_LatLng(40.760410,-73.964242))
2016-04-12 03:56:01 +08:00
```
2016-04-12 03:49:53 +08:00
Response:
2016-04-12 03:56:01 +08:00
2016-04-12 03:49:53 +08:00
_Coming soon_
2016-04-12 03:54:42 +08:00
### OBS_GetDemographicSnapshot
2016-04-12 03:49:53 +08:00
API Example:
2016-04-12 03:54:42 +08:00
```text
https://observatory.cartodb.com/api/v2/sql?q=SELECT%20*%20FROM%20OBS_GetDemographicSnapshot(CDB_LatLng(40.760410,-73.964242))
```
2016-04-12 03:49:53 +08:00
Response:
[Click to expand](https://gist.github.com/ohasselblad/c9e59a6e8da35728d0d81dfed131ed17)