Sisu Api Documentation (V1)
Sisu’s key-driver analysis API’s can be used to programmatically sync insights outside of Sisu.
List all analyses.
Authorizations:
query Parameters
analysisType | string Default: "ANALYSIS_TYPE_UNKNOWN" Enum: "ANALYSIS_TYPE_UNKNOWN" "ANALYSIS_TYPE_GENERAL_PERFORMANCE" "ANALYSIS_TYPE_TREND" "ANALYSIS_TYPE_TIME_COMPARE" "ANALYSIS_TYPE_GROUP_COMPARE" What type of analyses to include in the results. If not set all types will be returned. |
limit | string <uint64> A limit on the number of objects to be returned, between 1 and 10000. Default value is 10000. |
startingAfter | string <int64> starting_after is an object ID that defines your place in the list. For instance, if you make a analysis list request and receive 100, ending with id = 89, your subsequent call can include starting_after=89 in order to fetch the next page of the list. |
Responses
Response Schema: application/json
Array of objects (v1apiAnalysis) [ items ] List of analyses. | |
object (Pagination hints which indicate if more data is available
next_starting_cursor indicate the next id to be used for starting_after pagination parameter) |
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Response samples
- 200
- default
{- "analyses": [
- {
- "applicationUrl": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "metricId": "string",
- "name": "string",
- "projectId": "string",
- "type": "ANALYSIS_TYPE_UNKNOWN"
}
], - "paginationHints": {
- "hasMore": true,
- "nextStartingCursor": "string"
}
}
Update existing Analysis with a new version.
Authorizations:
path Parameters
analysisId_1 required | string <uint64> |
query Parameters
name | string The name of the analysis. |
Request Body schema: application/json
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
groupAName | string The Group a name in a Group compare analysis. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
groupBName | string The Group b name in a Group compare analysis. |
name | string The name of the analysis. |
object (apiTimeWindow) | |
object (apiTimeWindow) | |
timeDimensionName | string The name of metric's time dimension which represnts the date range of the metric. |
object (apiTimeWindow) | |
type | string (apiAnalysisType) Default: "ANALYSIS_TYPE_UNKNOWN" Enum: "ANALYSIS_TYPE_UNKNOWN" "ANALYSIS_TYPE_GENERAL_PERFORMANCE" "ANALYSIS_TYPE_TREND" "ANALYSIS_TYPE_TIME_COMPARE" "ANALYSIS_TYPE_GROUP_COMPARE" Type of Analysis eg. KEY_DRIVER. |
Responses
Response Schema: application/json
applicationUrl | string (Link to the live sisu analysis this represents. ex: vip.sisudata.com/projects/{id}/analysis/{id}) |
createdAt | string <date-time> Timestamp when the analysis was created. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
groupAName | string The Group a name in a Group compare analysis. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
groupBName | string The Group b name in a Group compare analysis. |
id | string <uint64> Analysis id. |
metricId | string <uint64> The metic id which the analysis depends on. |
name | string The name of the analysis. |
object (apiTimeWindow) | |
projectId | string <uint64> Project id corresponding to the analysis. |
object (apiTimeWindow) | |
timeDimensionName | string The name of metric's time dimension which represnts the date range of the metric. |
object (apiTimeWindow) | |
type | string (apiAnalysisType) Default: "ANALYSIS_TYPE_UNKNOWN" Enum: "ANALYSIS_TYPE_UNKNOWN" "ANALYSIS_TYPE_GENERAL_PERFORMANCE" "ANALYSIS_TYPE_TREND" "ANALYSIS_TYPE_TIME_COMPARE" "ANALYSIS_TYPE_GROUP_COMPARE" Type of Analysis eg. KEY_DRIVER. |
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Request samples
- Payload
{- "filterExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "dimensionName": "string",
- "literal": {
- "bool": true,
- "float": 0,
- "int": "string",
- "string": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "nullLiteral": { },
- "operator": "OPERATOR_UNKNOWN"
}, - "or": {
- "expressions": [
- { }
]
}
}, - "groupAExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "dimensionName": "string",
- "literal": {
- "bool": true,
- "float": 0,
- "int": "string",
- "string": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "nullLiteral": { },
- "operator": "OPERATOR_UNKNOWN"
}, - "or": {
- "expressions": [
- { }
]
}
}, - "groupAName": "string",
- "groupBExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "dimensionName": "string",
- "literal": {
- "bool": true,
- "float": 0,
- "int": "string",
- "string": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "nullLiteral": { },
- "operator": "OPERATOR_UNKNOWN"
}, - "or": {
- "expressions": [
- { }
]
}
}, - "groupBName": "string",
- "name": "string",
- "previousRange": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "recentRange": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "timeDimensionName": "string",
- "timeRange": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "type": "ANALYSIS_TYPE_UNKNOWN"
}
Response samples
- 200
- default
{- "applicationUrl": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "filterExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "dimensionName": "string",
- "literal": {
- "bool": true,
- "float": 0,
- "int": "string",
- "string": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "nullLiteral": { },
- "operator": "OPERATOR_UNKNOWN"
}, - "or": {
- "expressions": [
- { }
]
}
}, - "groupAExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "dimensionName": "string",
- "literal": {
- "bool": true,
- "float": 0,
- "int": "string",
- "string": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "nullLiteral": { },
- "operator": "OPERATOR_UNKNOWN"
}, - "or": {
- "expressions": [
- { }
]
}
}, - "groupAName": "string",
- "groupBExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "dimensionName": "string",
- "literal": {
- "bool": true,
- "float": 0,
- "int": "string",
- "string": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "nullLiteral": { },
- "operator": "OPERATOR_UNKNOWN"
}, - "or": {
- "expressions": [
- { }
]
}
}, - "groupBName": "string",
- "id": "string",
- "metricId": "string",
- "name": "string",
- "previousRange": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "projectId": "string",
- "recentRange": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "timeDimensionName": "string",
- "timeRange": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "type": "ANALYSIS_TYPE_UNKNOWN"
}
Modify existing Analysis.
Authorizations:
path Parameters
analysisId required | string <uint64> |
Request Body schema: application/json
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
groupAName | string The Group a name in a Group compare analysis. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
groupBName | string The Group b name in a Group compare analysis. |
name | string The name of the analysis. |
object (apiTimeWindow) | |
object (apiTimeWindow) | |
timeDimensionName | string The name of metric's time dimension which represnts the date range of the metric. |
object (apiTimeWindow) |
Responses
Response Schema: application/json
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Request samples
- Payload
{- "filterExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "dimensionName": "string",
- "literal": {
- "bool": true,
- "float": 0,
- "int": "string",
- "string": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "nullLiteral": { },
- "operator": "OPERATOR_UNKNOWN"
}, - "or": {
- "expressions": [
- { }
]
}
}, - "groupAExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "dimensionName": "string",
- "literal": {
- "bool": true,
- "float": 0,
- "int": "string",
- "string": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "nullLiteral": { },
- "operator": "OPERATOR_UNKNOWN"
}, - "or": {
- "expressions": [
- { }
]
}
}, - "groupAName": "string",
- "groupBExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "dimensionName": "string",
- "literal": {
- "bool": true,
- "float": 0,
- "int": "string",
- "string": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "nullLiteral": { },
- "operator": "OPERATOR_UNKNOWN"
}, - "or": {
- "expressions": [
- { }
]
}
}, - "groupBName": "string",
- "name": "string",
- "previousRange": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "recentRange": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "timeDimensionName": "string",
- "timeRange": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}
}
Response samples
- 200
- default
{ }
List all Dimensions for a given AnalysisDimensionsListRequest.
Authorizations:
path Parameters
analysisId required | string <int64> Unique ID corresponding to the analysis containing the dimensions. |
query Parameters
isSelected | string Will return only active or non active dimensions for a given analysis. |
Responses
Response Schema: application/json
Array of objects (apiAnalysisDimension) [ items ] | |||||||
Array
|
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Response samples
- 200
- default
{- "dimensions": [
- {
- "dimensionType": "SQL_DATA_TYPE_UNKNOWN",
- "isSelected": true,
- "name": "string"
}
]
}
Creates new duplicate analysis with a given name or with '(copy)' subfix. Returns new analysis id.
Authorizations:
path Parameters
id required | string <uint64> Analysis id to be duplicated |
Request Body schema: application/json
optinal name for the new analysis
Responses
Response Schema: application/json
id | string <uint64> Newly created Analysis id. |
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Request samples
- Payload
"string"
Response samples
- 200
- default
{- "id": "string"
}
Get analysis filters.
Authorizations:
path Parameters
id required | string <int64> Analysis id. |
Responses
Response Schema: application/json
object (apiExpression) An Expression which would facilitate building a filter expression. | |||||||
|
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Response samples
- 200
- default
{- "filterExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "dimensionName": "string",
- "literal": {
- "bool": true,
- "float": 0,
- "int": "string",
- "string": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "nullLiteral": { },
- "operator": "OPERATOR_UNKNOWN"
}, - "or": {
- "expressions": [
- { }
]
}
}
}
Set analysis filters.
Authorizations:
path Parameters
id required | string <int64> Analysis id. |
Request Body schema: application/json
A filter expression must be one of 'and'/'or' [expression] with min of 2 expressions. or a single basicCondition.
object (ExpressionAndExpression) A conjunction of boolean expressions e.g. | |
object (An basic boolean expression e.g. `"sale_price" > 100`.
{
"dimensionName" : "sale_price",
"operator" : "OPERATOR_LT",
"literal" : {
"int" : 100
}
}) | |
object (ExpressionOrExpression) A conjunction of boolean expressions e.g. |
Responses
Response Schema: application/json
Response with empty message.
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Request samples
- Payload
{- "and": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "dimensionName": "string",
- "literal": {
- "bool": true,
- "float": 0,
- "int": "string",
- "string": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "nullLiteral": { },
- "operator": "OPERATOR_UNKNOWN"
}, - "or": {
- "expressions": [
- { }
]
}
}
Response samples
- 200
- default
{ }
Run Analysis execution.
Authorizations:
path Parameters
id required | string <int64> Analysis id. |
Responses
Response Schema: application/json
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Response samples
- 200
- default
{ }
Returns the results corresponding to the latest analysis run.
Authorizations:
path Parameters
id required | string <int64> Analysis Id. |
query Parameters
limit | string <uint64> A limit on the number of objects to be returned, between 1 and 10000. Default value is 10000. |
startingAfter | string <int64> starting_after is an object ID that defines your place in the list. For instance, if you make a analysis list request and receive 100, ending with id = 89, your subsequent call can include starting_after=89 in order to fetch the next page of the list. |
confidenceGte | string filter by confidence levels of greater than equal to HIGH, MEDIUM or LOW |
Responses
Response Schema: application/json
object (apiAnalysisResult) Provides details of an analysis run. | |
object (Pagination hints which indicate if more data is available
next_starting_cursor indicate the next id to be used for starting_after pagination parameter) |
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Response samples
- 200
- default
{- "analysisResult": {
- "applicationUrl": "string",
- "completedAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "keyDriverAnalysisResult": {
- "generalPerformance": { },
- "groupComparison": {
- "groupA": {
- "name": "string"
}, - "groupB": {
- "name": "string"
}
}, - "segments": [
- {
- "confidence": "CONFIDENCE_LEVEL_UNKNOWN",
- "factors": {
- "property1": {
- "bin": {
- "lowerBound": 0,
- "lowerBoundPercentile": 0,
- "upperBound": 0,
- "upperBoundPercentile": 0
}, - "keyword": {
- "keyword": "string"
}, - "value": {
- "booleanValue": true,
- "floatValue": 0,
- "integerValue": "string",
- "stringValue": "string",
- "timestampValue": "2019-08-24T14:15:22Z"
}
}, - "property2": {
- "bin": {
- "lowerBound": 0,
- "lowerBoundPercentile": 0,
- "upperBound": 0,
- "upperBoundPercentile": 0
}, - "keyword": {
- "keyword": "string"
}, - "value": {
- "booleanValue": true,
- "floatValue": 0,
- "integerValue": "string",
- "stringValue": "string",
- "timestampValue": "2019-08-24T14:15:22Z"
}
}
}, - "generalPerformance": {
- "size": 0,
- "value": 0
}, - "groupComparison": {
- "groupASize": 0,
- "groupAValue": 0,
- "groupBSize": 0,
- "groupBValue": 0
}, - "id": "string",
- "impact": 0,
- "timeComparison": {
- "previousPeriodSize": 0,
- "previousPeriodValue": 0,
- "recentPeriodSize": 0,
- "recentPeriodValue": 0
}
}
], - "summaryCard": {
- "generalPerformanceCard": {
- "average": 0,
- "cardLabel": "string",
- "categoryFilter": "string",
- "matchSize": 0,
- "max": 0,
- "median": 0,
- "min": 0,
- "sum": 0,
- "summaryValue": 0,
- "totalDenominator": 0,
- "totalNumerator": 0,
- "totalSize": 0,
- "weight": 0,
- "weightedAverage": 0,
- "weightedSum": 0
}, - "groupComparisonCard": {
- "groupACard": {
- "average": 0,
- "cardLabel": "string",
- "categoryFilter": "string",
- "matchSize": 0,
- "max": 0,
- "median": 0,
- "min": 0,
- "sum": 0,
- "summaryValue": 0,
- "totalDenominator": 0,
- "totalNumerator": 0,
- "totalSize": 0,
- "weight": 0,
- "weightedAverage": 0,
- "weightedSum": 0
}, - "groupAFilter": "string",
- "groupBCard": {
- "average": 0,
- "cardLabel": "string",
- "categoryFilter": "string",
- "matchSize": 0,
- "max": 0,
- "median": 0,
- "min": 0,
- "sum": 0,
- "summaryValue": 0,
- "totalDenominator": 0,
- "totalNumerator": 0,
- "totalSize": 0,
- "weight": 0,
- "weightedAverage": 0,
- "weightedSum": 0
}, - "groupBFilter": "string",
- "percentChange": 0
}, - "metricTypeLabel": "string",
- "timeComparisonCard": {
- "currentPeriod": {
- "endDateInclusive": "2019-08-24T14:15:22Z",
- "startDateInclusive": "2019-08-24T14:15:22Z"
}, - "currentPeriodCard": {
- "average": 0,
- "cardLabel": "string",
- "categoryFilter": "string",
- "matchSize": 0,
- "max": 0,
- "median": 0,
- "min": 0,
- "sum": 0,
- "summaryValue": 0,
- "totalDenominator": 0,
- "totalNumerator": 0,
- "totalSize": 0,
- "weight": 0,
- "weightedAverage": 0,
- "weightedSum": 0
}, - "percentChange": 0,
- "previousPeriod": {
- "endDateInclusive": "2019-08-24T14:15:22Z",
- "startDateInclusive": "2019-08-24T14:15:22Z"
}, - "previousPeriodCard": {
- "average": 0,
- "cardLabel": "string",
- "categoryFilter": "string",
- "matchSize": 0,
- "max": 0,
- "median": 0,
- "min": 0,
- "sum": 0,
- "summaryValue": 0,
- "totalDenominator": 0,
- "totalNumerator": 0,
- "totalSize": 0,
- "weight": 0,
- "weightedAverage": 0,
- "weightedSum": 0
}
}
}, - "timeComparison": {
- "previousPeriod": {
- "endDateInclusive": "2019-08-24T14:15:22Z",
- "startDateInclusive": "2019-08-24T14:15:22Z"
}, - "recentPeriod": {
- "endDateInclusive": "2019-08-24T14:15:22Z",
- "startDateInclusive": "2019-08-24T14:15:22Z"
}
}
}, - "metricId": "string",
- "requestedAt": "2019-08-24T14:15:22Z",
- "resultVersion": "string",
- "runStatus": "RUN_STATUS_UNKNOWN",
- "runType": "RUN_TYPE_UNKNOWN",
- "trendAnalysisResult": {
- "overallTrends": [
- {
- "intercept": 0,
- "size": 0,
- "timeRange": {
- "endDateInclusive": "2019-08-24T14:15:22Z",
- "startDateInclusive": "2019-08-24T14:15:22Z"
}, - "trend": 0
}
], - "segments": [
- {
- "factors": {
- "property1": {
- "bin": {
- "lowerBound": 0,
- "lowerBoundPercentile": 0,
- "upperBound": 0,
- "upperBoundPercentile": 0
}, - "keyword": {
- "keyword": "string"
}, - "value": {
- "booleanValue": true,
- "floatValue": 0,
- "integerValue": "string",
- "stringValue": "string",
- "timestampValue": "2019-08-24T14:15:22Z"
}
}, - "property2": {
- "bin": {
- "lowerBound": 0,
- "lowerBoundPercentile": 0,
- "upperBound": 0,
- "upperBoundPercentile": 0
}, - "keyword": {
- "keyword": "string"
}, - "value": {
- "booleanValue": true,
- "floatValue": 0,
- "integerValue": "string",
- "stringValue": "string",
- "timestampValue": "2019-08-24T14:15:22Z"
}
}
}, - "id": "string",
- "impact": 0,
- "trends": [
- {
- "intercept": 0,
- "size": 0,
- "timeRange": {
- "endDateInclusive": "2019-08-24T14:15:22Z",
- "startDateInclusive": "2019-08-24T14:15:22Z"
}, - "trend": 0
}
]
}
], - "summaryCard": {
- "currentPeriod": {
- "cardLabel": "string",
- "denominatorLabel": "string",
- "percentChange": 0,
- "slope": 0
}, - "previousPeriod": {
- "cardLabel": "string",
- "denominatorLabel": "string",
- "percentChange": 0,
- "slope": 0
}
}
}
}, - "paginationHints": {
- "hasMore": true,
- "nextStartingCursor": "string"
}
}
Get Waterfall Sequence for Analysis.
Authorizations:
path Parameters
id required | string <uint64> Analysis id |
Responses
Response Schema: application/json
Array of objects (apiWaterfallStep) [ items ] | |||||||||||||
Array
|
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Response samples
- 200
- default
{- "waterfall": [
- {
- "changeInSize": {
- "subgroupA": 0,
- "subgroupB": 0
}, - "changeInType": {
- "subgroupA": 0,
- "subgroupB": 0
}, - "cumulativeImpactAfterStep": 0,
- "cumulativeImpactBeforeStep": 0,
- "factors": {
- "property1": {
- "bin": {
- "lowerBound": 0,
- "lowerBoundPercentile": 0,
- "upperBound": 0,
- "upperBoundPercentile": 0
}, - "keyword": {
- "keyword": "string"
}, - "value": {
- "booleanValue": true,
- "floatValue": 0,
- "integerValue": "string",
- "stringValue": "string",
- "timestampValue": "2019-08-24T14:15:22Z"
}
}, - "property2": {
- "bin": {
- "lowerBound": 0,
- "lowerBoundPercentile": 0,
- "upperBound": 0,
- "upperBoundPercentile": 0
}, - "keyword": {
- "keyword": "string"
}, - "value": {
- "booleanValue": true,
- "floatValue": 0,
- "integerValue": "string",
- "stringValue": "string",
- "timestampValue": "2019-08-24T14:15:22Z"
}
}
}, - "overlappingImpact": 0
}
]
}
List all Metrics.
Authorizations:
Responses
Response Schema: application/json
Array of objects (apiMetric) [ items ] | |||||||||||||||||||
Array
|
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Response samples
- 200
- default
{- "metrics": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "datasetId": "string",
- "desiredDirection": "DESIRED_DIRECTION_UNKNOWN",
- "id": "string",
- "metricDimension": {
- "name": "string",
- "value": {
- "booleanValue": true,
- "floatValue": 0,
- "integerValue": "string",
- "stringValue": "string",
- "timestampValue": "2019-08-24T14:15:22Z"
}
}, - "name": "string",
- "timeDimensionName": "string",
- "type": "METRIC_TYPE_UNKNOWN",
- "weightDimensionName": "string"
}
]
}
List all data sets.
Authorizations:
Responses
Response Schema: application/json
Array of objects (v1apiDataset) [ items ] | |||||||||||||||
Array
|
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Response samples
- 200
- default
{- "datasets": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "dataSourceId": "string",
- "datasetType": "DATASET_TYPE_UNKNOWN",
- "id": "string",
- "lastModified": "2019-08-24T14:15:22Z",
- "name": "string",
- "queryString": "string"
}
]
}
List all Dimensions for a given DataSetDimensionsListRequest.
Authorizations:
path Parameters
datasetId required | string <int64> Unique ID corresponding to the dataset containing the dimensions. |
Responses
Response Schema: application/json
Array of objects (apiDimension) [ items ] | |||||||
Array
|
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Response samples
- 200
- default
{- "dimensions": [
- {
- "datasetId": "string",
- "dimensionType": "SQL_DATA_TYPE_UNKNOWN",
- "name": "string"
}
]
}
List all data sources.
Authorizations:
Responses
Response Schema: application/json
Array of objects (apiDataSource) [ items ] | |||||||||||||
Array
|
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Response samples
- 200
- default
{- "dataSources": [
- {
- "connectionUri": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "dataSourceType": "DATA_SOURCE_TYPE_UNKNOWN",
- "id": "string",
- "name": "string"
}
]
}
Create a new data sets query.
Authorizations:
path Parameters
dataSourceId required | string <uint64> |
Request Body schema: application/json
name | string Name of the dataset. |
queryString | string A SQL query string for a datasete of type query. |
Responses
Response Schema: application/json
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Request samples
- Payload
{- "name": "string",
- "queryString": "string"
}
Response samples
- 200
- default
{ }
Gets the query to retrieve the rows that make up this segment.
Authorizations:
path Parameters
id required | string <uint64> Segment id to get data for. |
Responses
Response Schema: application/json
queryString | string query string that would result in the segment data. |
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Response samples
- 200
- default
{- "queryString": "string"
}
List of analyses for a given project id.
Authorizations:
path Parameters
id required | string <uint64> Project id. |
Responses
Response Schema: application/json
Array of objects (v1apiAnalysis) [ items ] List of analyses associated with a project. | |||||||||||||||
Array
|
Response Schema: application/json
code | integer <int32> |
Array of objects (protobufAny) [ items ] | |
message | string |
Response samples
- 200
- default
{- "analyses": [
- {
- "applicationUrl": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "metricId": "string",
- "name": "string",
- "projectId": "string",
- "type": "ANALYSIS_TYPE_UNKNOWN"
}
]
}