Skip to content

Commit 739720d

Browse files
hermosillajelmyhermosillajelmy
authored
Merge pull request #1155 from DataUSA/jh-documentation
update tesseract API
2 parents d1d44ab + d2c3306 commit 739720d

File tree

1 file changed

+26
-32
lines changed

1 file changed

+26
-32
lines changed

‎app/pages/Data/API.jsx‎

Lines changed: 26 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import React, {Component} from "react";
22
import {Link} from "react-router";
33
import {connect} from "react-redux";
44

5-
class API extends Component {
5+
export default class API extends Component {
66

77
render() {
88

@@ -34,8 +34,8 @@ class API extends Component {
3434
Returns a list of all available data cubes in the Tesseract server.
3535
</p>
3636
<p>
37-
<a href={`${this.props.TESSERACT}tesseract/cubes`} target="_blank">
38-
{this.props.TESSERACT}tesseract<strong>/cubes</strong>
37+
<a href={`https://api.datausa.io/tesseract/cubes`} target="_blank">
38+
https://api.datausa.io/tesseract<strong>/cubes</strong>
3939
</a>
4040
</p>
4141

@@ -48,8 +48,8 @@ class API extends Component {
4848
Returns the full schema of a specific cube, including its measures, dimensions, and levels.
4949
</p>
5050
<p>
51-
<a href={`${this.props.TESSERACT}tesseract/cubes/acs_yg_total_population_5`} target="_blank">
52-
{this.props.TESSERACT}tesseract<strong>/cubes/acs_yg_total_population_5</strong>
51+
<a href={`https://api.datausa.io/tesseract/cubes/acs_yg_total_population_5`} target="_blank">
52+
https://api.datausa.io/tesseract<strong>/cubes/acs_yg_total_population_5</strong>
5353
</a>
5454
</p>
5555

@@ -63,8 +63,8 @@ class API extends Component {
6363
This is useful for populating filters or understanding the scope of available data in a dimension level.
6464
</p>
6565
<p>
66-
<a href={`${this.props.TESSERACT}tesseract/members?cube=acs_yg_total_population_5&level=State`} target="_blank">
67-
{this.props.TESSERACT}tesseract<strong>/members?cube=acs_yg_total_population_5&level=State</strong>
66+
<a href={`https://api.datausa.io/tesseract/members?cube=acs_yg_total_population_5&level=State`} target="_blank">
67+
https://api.datausa.io/tesseract<strong>/members?cube=acs_yg_total_population_5&level=State</strong>
6868
</a>
6969
</p>
7070

@@ -96,15 +96,15 @@ class API extends Component {
9696
In this case we analyze the population by state in 2023:
9797
</p>
9898
<p>
99-
<a href={`${this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023&drilldowns=State,Year`} target="_blank">
100-
{this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&drilldowns=State,Year&measures=Population&include=Year:2023&limit=100,0
99+
<a href={`https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023&drilldowns=State,Year`} target="_blank">
100+
https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&drilldowns=State,Year&measures=Population&include=Year:2023&limit=100,0
101101
</a>
102102
</p>
103103

104104
<h4><b>1. Root URL</b></h4>
105105
<p>
106106
<code style={{backgroundColor: '#eee' }}>
107-
{this.props.TESSERACT}tesseract/data.jsonrecords
107+
https://api.datausa.io/tesseract/data.jsonrecords
108108
</code>
109109
</p>
110110
<p>
@@ -185,8 +185,8 @@ class API extends Component {
185185
In this case we're we'll stick with our previous example of the population by state in 2023:
186186
</p>
187187
<p>
188-
<a href={`${this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023&drilldowns=State,Year`} target="_blank">
189-
{this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&drilldowns=State,Year&measures=Population&include=Year:2023&limit=100,0
188+
<a href={`https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023&drilldowns=State,Year`} target="_blank">
189+
https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&drilldowns=State,Year&measures=Population&include=Year:2023&limit=100,0
190190
</a>
191191
</p>
192192

@@ -299,8 +299,8 @@ class API extends Component {
299299
For example, the following API call will include data only for the 2023 and for Alabama:
300300
</p>
301301
<p>
302-
<a href={`${this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023;State:04000US01&drilldowns=State,Year`} target="_blank">
303-
{this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023;State:04000US01&drilldowns=State,Year
302+
<a href={`https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023;State:04000US01&drilldowns=State,Year`} target="_blank">
303+
https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023;State:04000US01&drilldowns=State,Year
304304
</a>
305305
</p>
306306

@@ -320,8 +320,8 @@ class API extends Component {
320320
For example, the following API call will return data for all available states except for Alabama:
321321
</p>
322322
<p>
323-
<a href={`${this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&exclude=State:04000US01&drilldowns=State`} target="_blank">
324-
{this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&exclude:State:04000US01&drilldowns=State
323+
<a href={`https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&exclude=State:04000US01&drilldowns=State`} target="_blank">
324+
https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&exclude:State:04000US01&drilldowns=State
325325
</a>
326326
</p>
327327

@@ -341,8 +341,8 @@ class API extends Component {
341341
For example, the following API call will include parent members for the County level:
342342
</p>
343343
<p>
344-
<a href={`${this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023&drilldowns=County,Year&parents=True`} target="_blank">
345-
{this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023&drilldowns=County,Year
344+
<a href={`https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023&drilldowns=County,Year&parents=True`} target="_blank">
345+
https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023&drilldowns=County,Year
346346
&parents=True
347347
</a>
348348
</p>
@@ -420,15 +420,15 @@ class API extends Component {
420420
</p>
421421
<p>For example, to sort by Population in ascending order:</p>
422422
<p>
423-
<a href={`${this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023&drilldowns=State,Year&sort=Population.asc`} target="_blank">
424-
{this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023&drilldowns=State,Year
423+
<a href={`https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023&drilldowns=State,Year&sort=Population.asc`} target="_blank">
424+
https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&include=Year:2023&drilldowns=State,Year
425425
&sort=Population.asc
426426
</a>
427427
</p>
428428
<p>Or, to fetch the top state above a threshold of 30 million sorted by year:</p>
429429
<p>
430-
<a href={`${this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&drilldowns=State,Year&filters=Population.gt.30000000&sort=Year.desc`} target="_blank">
431-
{this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&drilldowns=State,Year&filters=Population.gt.30000000
430+
<a href={`https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&drilldowns=State,Year&filters=Population.gt.30000000&sort=Year.desc`} target="_blank">
431+
https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&drilldowns=State,Year&filters=Population.gt.30000000
432432
&sort=Year.desc
433433
</a>
434434
</p>
@@ -445,14 +445,14 @@ class API extends Component {
445445
</p>
446446
<p>For example, to get the year of the highest population for each state:</p>
447447
<p>
448-
<a href={`${this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&drilldowns=State,Year&top=1.State.Population.desc`} target="_blank">
449-
{this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&drilldowns=State,Year&top=1.State.Population.desc
448+
<a href={`https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&drilldowns=State,Year&top=1.State.Population.desc`} target="_blank">
449+
https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&drilldowns=State,Year&top=1.State.Population.desc
450450
</a>
451451
</p>
452452
<p>Or, to get the 2 years with the highest population for each state:</p>
453453
<p>
454-
<a href={`${this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&drilldowns=State,Year&top=2.State.Population.desc`} target="_blank">
455-
{this.props.TESSERACT}tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&drilldowns=State,Year&top=2.State.Population.desc
454+
<a href={`https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&drilldowns=State,Year&top=2.State.Population.desc`} target="_blank">
455+
https://api.datausa.io/tesseract/data.jsonrecords?cube=acs_yg_total_population_5&measures=Population&drilldowns=State,Year&top=2.State.Population.desc
456456
</a>
457457
</p>
458458
<p><b>Note:</b> All columns mentioned in the parameter must be present in the request, either in drilldowns or measures.</p>
@@ -489,9 +489,3 @@ class API extends Component {
489489

490490
}
491491

492-
493-
const mapStateToProps = state => ({
494-
TESSERACT: state.env.TESSERACT
495-
});
496-
497-
export default connect(mapStateToProps)(API);

0 commit comments

Comments
 (0)