API Access

City life business of Miami

« Back to City life business of Miami

Access -- City life business of Miami

Credits

Log in and make sure you have enough Credits in your account. If you have not enough, buy credits.

API token

Generate an API token, a string of 40 alpha-numeric characters. It is a PASSWORD that you should keep for your own or share with only those who you trust.

Start querying

With credits in your account and API token ready, you can start querying the dataset:

https://www.datactory.com/api/data/v1/business_of_miami/

Copy and enter the above URL address in your browser address bar and you will be on your way.

401 Unauthorized ?

No surprise. That's because all API requests require an API token. Attach the token, e.g. XXXX, as a URL parameter like this:

https://www.datactory.com/api/data/v1/business_of_miami/?api_token=XXXX

Replace XXXX with your own API token and you should be seeing the index of the dataset, a list of available data tables.

Query a data table

Dataset (database) is comprised of one or more data tables. When you know the available tables in a dataset, you can query any of them, e.g. `business`, by:

https://www.datactory.com/api/data/v1/business_of_miami/business/?api_token=XXXX

Which will select the first rows of this table. If results are in JSON, follow links.next.href for the next page / batch of rows.

WHERE clause

You can specify which rows to select by certain criteria, known as WHERE clause in relational database queries. For example, for all `business` rows with `id` < 25:

https://www.datactory.com/api/data/v1/business_of_miami/business/business.id<25/?api_token=XXXX

Or for business.id between 90 and 150, inclusive:

https://www.datactory.com/api/data/v1/business_of_miami/business/business.id>=90,business.id<=150/?api_token=XXXX

Find out rows with column `field_1` being empty, `field_2` being "John Doe", and `field_3` being not "female":

https://www.datactory.com/api/data/v1/business_of_miami/business/business.field_1=,business.field_2=John%20Doe,business.field_3!=female/?api_token=XXXX

To search for a specific phrase against a table field, use the -LIKE- comparison operator in the WHERE clause via the online query tool, like this:

movie.title-LIKE-%the empire%

Which would return all movies with title containing the phrase "the empire", like "End of The Empire War", "The Empire Lost", etc. However, a search phrase starting with % is very likely very expensive in performance thus costing more Credits. A better approach if possible is to not use the leading % in -LIKE- searches, like this:

movie.title-LIKE-the empire%

Which would only search for movie titles starting with the phrase "the empire", like "The Empire Lost", "The Empires in History", etc.

LIMIT rows per page

Sometimes it makes sense to ask for more rows per page, or less. To do this, you need the limit parameter in the query URL:

https://www.datactory.com/api/data/v1/business_of_miami/business/?limit=200&api_token=XXXX

Which will select and return 200 rows at most per page. Allowed limits: 1, 10, 50, 100, 200, 500, 1000, 2000, 5000, 10000. Default limit: 100.

FIELDS (columns) to select

You can use fields parameter in the URL address to specify which columns / fields to select:

https://www.datactory.com/api/data/v1/business_of_miami/business/?limit=200&fields=business.title,business.slug&api_token=XXXX

Which will select the columns `title` and `slug` of table `business`.

To select ALL columns / fields, use __all:

https://www.datactory.com/api/data/v1/business_of_miami/business/?limit=200&fields=__all&api_token=XXXX

If no fields are specified in the request URL, however, only the `id` and `ts` columns will be returned. This is so that you can check if a particular row (by `id`) has been updated (`ts` changed) since your last retrieval and decide to fetch it again (for the updates) or not.

Formats

JSON is the default format of query results. To ask for a specific format for returned results, use the app parameter in request URL:

https://www.datactory.com/api/data/v1/business_of_miami/business/?limit=200&fields=__all&app=json&api_token=XXXX

Which will return the results in JSON. For now, we support:

  • json (JSON)
  • csv (CSV)

Json is both readable by end users and programmable by developers. Csv (Comma-separated Values) can be well handled by spreadsheet programs such as Excel, e.g.

https://www.datactory.com/api/data/v1/business_of_miami/business/?limit=200&fields=__all&app=csv&api_token=XXXX

Which will simply display the data results as CSV in your browser. To force download of the results into a file named yourfile.csv, use this:

https://www.datactory.com/api/data/v1/business_of_miami/business/?limit=200&fields=__all&app=csv&cfg[download]=1&cfg[filename]=yourfile.csv&api_token=XXXX

More formats are in the to-do list: excel, mysql, mssql, access, pdf, etc.

COUNT total rows

A query returns only a partial set (called page or batch) of ALL rows that match your request. For instance, the total number of rows matching the query may be 1,500, with each returned page giving 200 rows, you will go through 8 sequential pages to acquire all matching rows.

Since counting all potential rows for a given query is resource-intensive, you will have to explicitly ask for it if you need it, by attaching the count parameter in the request URL for JSON results:

https://www.datactory.com/api/data/v1/business_of_miami/business/?limit=200&fields=__all&count&api_token=XXXX

Now you should be seeing the total number of all potential rows in meta.stats.rowsTotal which by default remains NULL.

Note COUNT can be an expensive action that charges you by the time it needs for counting. It would be wise to use this only against small set of rows.

JOIN of tables

It's useful to have multiple tables joined together in a single query so we don't have to query each of the tables in separate queries. However, NOT all tables can be joined together. Only related tables can be joined in one query.

For instance, in a movies database, `movie` table is related to `director` table and vice versa since `movie` table has a field `director_id`, so the JOIN query of both tables looks like this:

https://www.datactory.com/api/data/v1/business_of_miami/movie,director/?limit=200&fields=__all&api_token=XXXX

To search for all movies by James Cameron, we have:

https://www.datactory.com/api/data/v1/business_of_miami/director,movie/director.name=James Cameron/?limit=200&fields=__all&api_token=XXXX

Further, to find movies directed by James Cameron and that have Leonardo DeCaprio as an actor, we will join yet another 2 tables, `actor` and `movie_x_actor` (with relational fields `movie_id` and `actor_id`):

https://www.datactory.com/api/data/v1/business_of_miami/movie,director,movie_x_actor,actor/director.name=James Cameron,actor.name=Leonardo DeCaprio/?limit=200&fields=__all&api_token=XXXX

Order of tables do matter here. In a joined / chained query of multiple tables, each table must have at least one immediately or directly related table to its left. In the example above we have:

movie,director,movie_x_actor,actor

Table `actor` is related to `movie_x_actor` at the left. Table `movie_x_actor` is related to table `movie` at the left. Table `director` has a related table `movie` at the left. So there you go, we have a collection of correctly joined tables in proper order.

However, would this work?

movie,director,actor,movie_x_actor

No, because there are NO tables related to `actor` at its left. Neither `director` nor `movie` is immediately related to table `actor`. So an error will be given in this regard:

Table(s) `actor` cannot be joined to `movie`,`director`,`movie_x_actor`. Changing tables order may fix this.

Would this work?

movie_x_actor,actor,movie,director

Yes, since every table has a related table at its left.

Switch the positions of `director` and `movie` and we have:

movie_x_actor,actor,director,movie

Would it work? No. Because table `director` finds no related table at its left.

 

 

 

 

 

 

Stay tuned for more docs (Coming Soon)

Read tutorials and docs to become a Datactory expert and integrate Datactory datasets to any project without having to worry about data updates and synchronization again.