Analytics provides REST APIs that a client application can use to invoke services using simple HTTP methods. A catalog of available REST resources and requests is provided below.
The Analytics REST APIs can be called on any node running the analytics service. By default, the Analytics REST endpoints below listen on port 8095, or 18095 for secure access. Note that the Settings API listens on port 8091, or 18091 for secure access.
For the examples, we assume that:
-
You’re running a Couchbase node with the Analytics service using the default port on localhost.
-
You authenticate as a user with the "Full Administrator" role with the user name "Administrator" and the password "password".
APIs in this Section
For a list of the methods and URIs covered in these pages, see the tables below.
Analytics Query API
| HTTP Method | URI | Documented at |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Analytics Admin API
| HTTP Method | URI | Documented at |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Analytics Config API
| HTTP Method | URI | Documented at |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Analytics Settings API
| HTTP Method | URI | Documented at |
|---|---|---|
|
|
|
|
|
Analytics Links API
| HTTP Method | URI | Documented at |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|