Analytics Query Responses
Common Responses
The Couchbase Analytics Service API returns the following responses in common with the N1QL for Query REST API.
Parameter | Type | Description |
---|---|---|
|
UUID |
A unique identifier for the response. |
|
string |
The client context ID of the request, if one was supplied — refer to |
|
object |
The schema of the results. Present only when the query completes successfully. |
|
list |
A list of all the objects returned by the query. An object can be any JSON value. |
|
enum |
The status of the request. Possible values are: |
|
list |
A list of error objects. Present only if 1 or more errors are returned during processing of the request. Each error is represented by an object in this list. |
|
int |
A number that identifies the error. |
|
string |
A message describing the error in detail. |
|
list |
A list of warning objects. Present only if 1 or more warnings are returned during processing of the request. Each warning is represented by an object in this list. |
|
int |
A number that identifies the warning. |
|
string |
A message describing the warning in detail. |
|
object |
An object containing metrics about the request. |
|
string |
The total time taken for the request, that is the time from when the request was received until the results were returned. |
|
string |
The time taken for the execution of the request, that is the time from when query execution started until the results were returned. |
|
unsigned int |
The total number of objects in the results. |
|
unsigned int |
The total number of bytes in the results. |
|
unsigned int |
The number of errors that occurred during the request. |
|
unsigned int |
The number of warnings that occurred during the request. |
For more information on these common responses, refer to the Response section on the N1QL for Query REST API page.
Analytics Responses
In addition, the Service API returns the following responses which are unique to Analytics.
Parameter | Type | Description |
---|---|---|
|
long |
Number of processed tuples during query execution. |
|
object |
Possible elements: |