Skip to content

Commit cf0973c

Browse files
authored
Update readme with new doc links
1 parent 64eff54 commit cf0973c

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Official JavaScript client for [SlicingDice](http://www.slicingdice.com/), Data
77

88
## Documentation
99

10-
If you are new to SlicingDice, check our [quickstart guide](http://panel.slicingdice.com/docs/#quickstart-guide) and learn to use it in 15 minutes.
10+
If you are new to SlicingDice, check our [quickstart guide](https://docs.slicingdice.com/docs/quickstart-guide) and learn to use it in 15 minutes.
1111

12-
Please refer to the [SlicingDice official documentation](http://panel.slicingdice.com/docs/) for more information on [analytics databases](http://panel.slicingdice.com/docs/#analytics-concepts), [data modeling](http://panel.slicingdice.com/docs/#data-modeling), [data insertion](http://panel.slicingdice.com/docs/#data-insertion), [querying](http://panel.slicingdice.com/docs/#data-querying), [limitations](http://panel.slicingdice.com/docs/#current-slicingdice-limitations) and [API details](http://panel.slicingdice.com/docs/#api-details).
12+
Please refer to the [SlicingDice official documentation](https://docs.slicingdice.com/) for more information on [how to create a database](https://docs.slicingdice.com/docs/how-to-create-a-database), [how to insert data](https://docs.slicingdice.com/docs/how-to-insert-data), [how to make queries](https://docs.slicingdice.com/docs/how-to-make-queries), [how to create columns](https://docs.slicingdice.com/docs/how-to-create-columns), [SlicingDice restrictions](https://docs.slicingdice.com/docs/current-restrictions) and [API details](https://docs.slicingdice.com/docs/api-details).
1313

1414
## Tests and Examples
1515

@@ -74,20 +74,20 @@ client.countEntity(queryData).then((resp) => {
7474

7575
## Reference
7676

77-
`SlicingDice` encapsulates logic for sending requests to the API. Its methods are thin layers around the [API endpoints](http://panel.slicingdice.com/docs/#api-details-api-endpoints), so their parameters and return values are JSON-like `Object` objects with the same syntax as the [API endpoints](http://panel.slicingdice.com/docs/#api-details-api-endpoints)
77+
`SlicingDice` encapsulates logic for sending requests to the API. Its methods are thin layers around the [API endpoints](https://docs.slicingdice.com/docs/api-details), so their parameters and return values are JSON-like `Object` objects with the same syntax as the [API endpoints](https://docs.slicingdice.com/docs/api-details)
7878

7979
### Attributes
8080

81-
* `sdAddress (String)` - [Connection endpoint](http://panel.slicingdice.com/docs/#api-details-api-connection-connection-endpoints) to use when generating requests to SlicingDice.
81+
* `sdAddress (String)` - [Connection endpoint](https://docs.slicingdice.com/docs/api-keys) to use when generating requests to SlicingDice.
8282

8383
### Constructor
8484

8585
`SlicingDice(apiKeys, usesTestEndpoint)`
86-
* `apiKeys (Object)` - [API key](http://panel.slicingdice.com/docs/#api-details-api-connection-api-keys) to authenticate requests with the SlicingDice API.
86+
* `apiKeys (Object)` - [API key](https://docs.slicingdice.com/docs/api-keys) to authenticate requests with the SlicingDice API.
8787
* `usesTestEndpoint (boolean)` - If false the client will send requests to production end-point, otherwise to tests end-point.
8888

8989
### `getDatabase()`
90-
Get information about current database. This method corresponds to a [GET request at /database](http://panel.slicingdice.com/docs/#api-details-api-endpoints-get-database).
90+
Get information about current database. This method corresponds to a `GET` request at `/database`.
9191

9292
#### Request example
9393

@@ -117,7 +117,7 @@ client.getDatabase().then((resp) => {
117117
```
118118

119119
### `getColumns()`
120-
Get all created columns, both active and inactive ones. This method corresponds to a [GET request at /column](http://panel.slicingdice.com/docs/#api-details-api-endpoints-get-column).
120+
Get all created columns, both active and inactive ones. This method corresponds to a [GET request at /column](https://docs.slicingdice.com/docs/how-to-list-edit-or-delete-columns).
121121

122122
#### Request example
123123

@@ -164,7 +164,7 @@ client.getColumns().then((resp) => {
164164
```
165165

166166
### `createColumn(jsonData)`
167-
Create a new column. This method corresponds to a [POST request at /column](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-column).
167+
Create a new column. This method corresponds to a [POST request at /column](https://docs.slicingdice.com/docs/how-to-create-columns#section-creating-columns-using-column-endpoint).
168168

169169
#### Request example
170170

@@ -200,7 +200,7 @@ client.createColumn(column).then((resp) => {
200200
```
201201

202202
### `insert(jsonData)`
203-
Insert data to existing entities or create new entities, if necessary. This method corresponds to a [POST request at /insert](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-insert).
203+
Insert data to existing entities or create new entities, if necessary. This method corresponds to a [POST request at /insert](https://docs.slicingdice.com/docs/how-to-insert-data).
204204

205205
#### Request example
206206

@@ -266,7 +266,7 @@ client.insert(insertData).then((resp) => {
266266
```
267267

268268
### `existsEntity(ids, table = null)`
269-
Verify which entities exist in a table (uses `default` table if not provided) given a list of entity IDs. This method corresponds to a [POST request at /query/exists/entity](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-query-exists-entity).
269+
Verify which entities exist in a table (uses `default` table if not provided) given a list of entity IDs. This method corresponds to a [POST request at /query/exists/entity](https://docs.slicingdice.com/docs/exists).
270270

271271
#### Request example
272272

@@ -308,7 +308,7 @@ client.existsEntity(ids).then((resp) => {
308308
```
309309

310310
### `countEntityTotal()`
311-
Count the number of inserted entities in the whole database. This method corresponds to a [POST request at /query/count/entity/total](http://panel.slicingdice.com/docs/#api-details-api-endpoints-get-query-count-entity-total).
311+
Count the number of inserted entities in the whole database. This method corresponds to a [POST request at /query/count/entity/total](https://docs.slicingdice.com/docs/total).
312312

313313
#### Request example
314314

@@ -340,7 +340,7 @@ client.countEntityTotal().then((resp) => {
340340
```
341341

342342
### `countEntityTotal(tables)`
343-
Count the total number of inserted entities in the given tables. This method corresponds to a [POST request at /query/count/entity/total](http://panel.slicingdice.com/docs/#api-details-api-endpoints-get-query-count-entity-total).
343+
Count the total number of inserted entities in the given tables. This method corresponds to a [POST request at /query/count/entity/total](https://docs.slicingdice.com/docs/total#section-counting-specific-tables).
344344

345345
#### Request example
346346

@@ -374,7 +374,7 @@ client.countEntityTotal(tables).then((resp) => {
374374
```
375375

376376
### `countEntity(jsonData)`
377-
Count the number of entities matching the given query. This method corresponds to a [POST request at /query/count/entity](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-query-count-entity).
377+
Count the number of entities matching the given query. This method corresponds to a [POST request at /query/count/entity](https://docs.slicingdice.com/docs/count-entities).
378378

379379
#### Request example
380380

@@ -438,7 +438,7 @@ client.countEntity(query).then((resp) => {
438438
```
439439

440440
### `countEvent(jsonData)`
441-
Count the number of occurrences for time-series events matching the given query. This method corresponds to a [POST request at /query/count/event](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-query-count-event).
441+
Count the number of occurrences for time-series events matching the given query. This method corresponds to a [POST request at /query/count/event](https://docs.slicingdice.com/docs/count-events).
442442

443443
#### Request example
444444

@@ -504,7 +504,7 @@ client.countEvent(query).then((resp) => {
504504
```
505505

506506
### `topValues(jsonData)`
507-
Return the top values for entities matching the given query. This method corresponds to a [POST request at /query/top_values](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-query-top-values).
507+
Return the top values for entities matching the given query. This method corresponds to a [POST request at /query/top_values](https://docs.slicingdice.com/docs/top-values).
508508

509509
#### Request example
510510

@@ -572,7 +572,7 @@ client.topValues(query).then((resp) => {
572572
```
573573

574574
### `aggregation(jsonData)`
575-
Return the aggregation of all columns in the given query. This method corresponds to a [POST request at /query/aggregation](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-query-aggregation).
575+
Return the aggregation of all columns in the given query. This method corresponds to a [POST request at /query/aggregation](https://docs.slicingdice.com/docs/aggregations).
576576

577577
#### Request example
578578

@@ -634,7 +634,7 @@ client.aggregation(query).then((resp) => {
634634
```
635635

636636
### `getSavedQueries()`
637-
Get all saved queries. This method corresponds to a [GET request at /query/saved](http://panel.slicingdice.com/docs/#api-details-api-endpoints-get-query-saved).
637+
Get all saved queries. This method corresponds to a [GET request at /query/saved](https://docs.slicingdice.com/docs/saved-queries).
638638

639639
#### Request example
640640

@@ -693,7 +693,7 @@ client.getSavedQueries().then((resp) => {
693693
```
694694

695695
### `createSavedQuery(jsonData)`
696-
Create a saved query at SlicingDice. This method corresponds to a [POST request at /query/saved](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-query-saved).
696+
Create a saved query at SlicingDice. This method corresponds to a [POST request at /query/saved](https://docs.slicingdice.com/docs/saved-queries).
697697

698698
#### Request example
699699

@@ -756,7 +756,7 @@ client.createSavedQuery(query).then((resp) => {
756756
```
757757

758758
### `updateSavedQuery(queryName, jsonData)`
759-
Update an existing saved query at SlicingDice. This method corresponds to a [PUT request at /query/saved/QUERY_NAME](http://panel.slicingdice.com/docs/#api-details-api-endpoints-put-query-saved-query-name).
759+
Update an existing saved query at SlicingDice. This method corresponds to a [PUT request at /query/saved/QUERY_NAME](https://docs.slicingdice.com/docs/saved-queries).
760760

761761
#### Request example
762762

@@ -817,7 +817,7 @@ client.updateSavedQuery("my-saved-query", newQuery).then((resp) => {
817817
```
818818

819819
### `getSavedQuery(queryName)`
820-
Executed a saved query at SlicingDice. This method corresponds to a [GET request at /query/saved/QUERY_NAME](http://panel.slicingdice.com/docs/#api-details-api-endpoints-get-query-saved-query-name).
820+
Executed a saved query at SlicingDice. This method corresponds to a [GET request at /query/saved/QUERY_NAME](https://docs.slicingdice.com/docs/saved-queries).
821821

822822
#### Request example
823823

@@ -863,7 +863,7 @@ client.getSavedQuery("my-saved-query").then((resp) => {
863863
```
864864

865865
### `deleteSavedQuery(queryName)`
866-
Delete a saved query at SlicingDice. This method corresponds to a [DELETE request at /query/saved/QUERY_NAME](http://panel.slicingdice.com/docs/#api-details-api-endpoints-delete-query-saved-query-name).
866+
Delete a saved query at SlicingDice. This method corresponds to a [DELETE request at /query/saved/QUERY_NAME](https://docs.slicingdice.com/docs/saved-queries).
867867

868868
#### Request example
869869

@@ -907,7 +907,7 @@ client.deleteSavedQuery("my-saved-query").then((resp) => {
907907
```
908908

909909
### `result(jsonData)`
910-
Retrieve inserted values for entities matching the given query. This method corresponds to a [POST request at /data_extraction/result](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-data-extraction-result).
910+
Retrieve inserted values for entities matching the given query. This method corresponds to a [POST request at /data_extraction/result](https://docs.slicingdice.com/docs/result-extraction).
911911

912912
#### Request example
913913

@@ -966,7 +966,7 @@ client.result(query).then((resp) => {
966966
```
967967

968968
### `score(jsonData)`
969-
Retrieve inserted values as well as their relevance for entities matching the given query. This method corresponds to a [POST request at /data_extraction/score](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-data-extraction-score).
969+
Retrieve inserted values as well as their relevance for entities matching the given query. This method corresponds to a [POST request at /data_extraction/score](https://docs.slicingdice.com/docs/score-extraction).
970970

971971
#### Request example
972972

0 commit comments

Comments
 (0)