Pivot data cubes API
Create, read, or edit your data cubes using the Pivot API.
Get all data cubes or a get single named data cubes
Returns a list of all data cubes, or returns a data cube with a {name}
that you specify.
URL
GET /api/v1/data-cubes
Success response
Code | Description |
---|---|
200 | OK |
Selected error response
Code | Example body |
---|---|
404 Not Found | ”error": "Not found." |
Sample request
curl --location --request GET 'http://localhost:9095/api/v1/data-cubes' \
--header 'x-imply-api-token:<token>'
Response body
[
{
"name": "string",
"title": "string",
"description": "string",
"queryMode": "sql",
"source": {
"value": "string",
"connectionName": "string"
},
"group": "string",
"theme": "string",
"subsetFormula": "string",
"filterToken": "string",
"rollup": true,
"options": {
"additionalProp1": {}
},
"readAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"modifyAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"restrictedEditAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"attributes": [
{
"additionalProp1": {}
}
],
"dimension": [
{
"additionalProp1": {}
}
]
}
]
Create or update a data cube by name
Creates or updates a data cube with a {name}
that you specify.
URL
POST /api/v1/data-cubes
Request body
curl -X POST --header "Content-Type:application/json" --header "x-imply-api-token:<token>" --data '
{
"dataCube": {
"name": "string",
"title": "string",
"description": "string",
"queryMode": "sql",
"source": {
"value": "string",
"dataCubeName": "string"
},
"group": "string",
"theme": "string",
"subsetFormula": "string",
"filterToken": "string",
"rollup": true,
"options": {
"additionalProp1": {}
},
"readAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"modifyAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"restrictedEditAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"attributes": [
{
"additionalProp1": {}
}
],
"dimension": [
{
"additionalProp1": {}
}
]
}
}
Success response
Code | Description |
---|---|
200 | OK |
Selected error response
Code | Example body |
---|---|
404 Not Found | ”error": "Not found." |
Response body
[
{
"name": "string",
"title": "string",
"description": "string",
"queryMode": "sql",
"source": {
"value": "string",
"dataCubeName": "string"
},
"group": "string",
"theme": "string",
"subsetFormula": "string",
"filterToken": "string",
"rollup": true,
"options": {
"additionalProp1": {}
},
"readAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"modifyAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"restrictedEditAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"attributes": [
{
"additionalProp1": {}
}
],
"dimension": [
{
"additionalProp1": {}
}
]
}
]
Delete a data cube by name
Deletes a data cube with a {name}
that you specify.
URL
DELETE /api/v1/data-cubes/{name}
Sample request
curl -X DELETE --header "x-imply-api-token:<token>" localhost:9095/api/v1/data-cube/<dataCubeName>
Success response
Code | Description |
---|---|
200 | OK |
Selected error response
Code | Example body |
---|---|
404 Not Found | ”error": "Not found." |