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 Enum: "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) 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> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "analyses": [
- {
- "id": "string",
- "name": "string",
- "type": "ANALYSIS_TYPE_GENERAL_PERFORMANCE",
- "createdAt": "2019-08-24T14:15:22Z",
- "metricId": "string",
- "projectId": "string",
- "applicationUrl": "string"
}
], - "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
name | string The name of the analysis. |
type | string (apiAnalysisType) Enum: "ANALYSIS_TYPE_GENERAL_PERFORMANCE" "ANALYSIS_TYPE_TREND" "ANALYSIS_TYPE_TIME_COMPARE" "ANALYSIS_TYPE_GROUP_COMPARE" Type of Analysis eg. KEY_DRIVER. |
timeDimensionName | string The name of metric's time dimension which represents the date range of the metric. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiTimeWindow) | |
groupAName | string The Group a name in a Group compare analysis. |
groupBName | string The Group b name in a Group compare analysis. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiTimeWindow) | |
object (apiTimeWindow) |
Responses
Response Schema: application/json
name | string The name of the analysis. |
id | string <uint64> Analysis id. |
timeDimensionName | string The name of metric's time dimension which represents the date range of the metric. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
metricId | string <uint64> The metric id which the analysis depends on. |
object (apiTimeWindow) | |
groupAName | string The Group a name in a Group compare analysis. |
groupBName | string The Group b name in a Group compare analysis. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
projectId | string <uint64> Project id corresponding to the analysis. |
type | string (apiAnalysisType) Enum: "ANALYSIS_TYPE_GENERAL_PERFORMANCE" "ANALYSIS_TYPE_TREND" "ANALYSIS_TYPE_TIME_COMPARE" "ANALYSIS_TYPE_GROUP_COMPARE" Type of Analysis eg. KEY_DRIVER. |
createdAt | string <date-time> Timestamp when the analysis was created. |
applicationUrl | string (Link to the live sisu analysis this represents. ex: vip.sisudata.com/projects/{id}/analysis/{id}) |
object (apiTimeWindow) | |
object (apiTimeWindow) |
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Request samples
- Payload
{- "name": "string",
- "type": "ANALYSIS_TYPE_GENERAL_PERFORMANCE",
- "timeDimensionName": "string",
- "filterExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "timeRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "groupAName": "string",
- "groupBName": "string",
- "groupAExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "groupBExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "recentRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "previousRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}
}
Response samples
- 200
- default
{- "name": "string",
- "id": "string",
- "timeDimensionName": "string",
- "filterExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "metricId": "string",
- "timeRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "groupAName": "string",
- "groupBName": "string",
- "groupAExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "groupBExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "projectId": "string",
- "type": "ANALYSIS_TYPE_GENERAL_PERFORMANCE",
- "createdAt": "2019-08-24T14:15:22Z",
- "applicationUrl": "string",
- "recentRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "previousRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}
}
Modify existing Analysis.
Authorizations:
path Parameters
analysisId required | string <uint64> |
Request Body schema: application/json
name | string The name of the analysis. |
timeDimensionName | string The name of metric's time dimension which represents the date range of the metric. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiTimeWindow) | |
groupAName | string The Group a name in a Group compare analysis. |
groupBName | string The Group b name in a Group compare analysis. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiTimeWindow) | |
object (apiTimeWindow) |
Responses
Response Schema: application/json
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Request samples
- Payload
{- "name": "string",
- "timeDimensionName": "string",
- "filterExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "timeRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "groupAName": "string",
- "groupBName": "string",
- "groupAExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "groupBExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "recentRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "previousRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "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) | |||||||
Array
|
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "dimensions": [
- {
- "name": "string",
- "dimensionType": "SQL_DATA_TYPE_STRING",
- "isSelected": true
}
]
}
Get analyses by ID.
Authorizations:
path Parameters
id required | string <uint64> Analysis id to be fetch. |
Responses
Response Schema: application/json
name | string The name of the analysis. |
id | integer <int32> Analysis id. |
timeDimensionName | string The name of metric's time dimension which represents the date range of the metric. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
metricId | integer <int32> The metric id which the analysis depends on. |
object (apiTimeWindow) | |
groupAName | string The Group a name in a Group compare analysis. |
groupBName | string The Group b name in a Group compare analysis. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
projectId | integer <int32> Project id corresponding to the analysis. |
type | string (apiAnalysisType) Enum: "ANALYSIS_TYPE_GENERAL_PERFORMANCE" "ANALYSIS_TYPE_TREND" "ANALYSIS_TYPE_TIME_COMPARE" "ANALYSIS_TYPE_GROUP_COMPARE" Type of Analysis eg. KEY_DRIVER. |
createdAt | string <date-time> Timestamp when the analysis was created. |
applicationUrl | string (Link to the live sisu analysis this represents. ex: vip.sisudata.com/projects/{id}/analysis/{id}) |
object (apiTimeWindow) | |
object (apiTimeWindow) | |
createdByEmail | string Email ID of a user who created the analysis. |
lastModifiedAt | string <date-time> Timestamp of when analysis was last modified. |
lastModifiedByEmail | string Email ID of a user last modified this metric. |
lastRun | string <date-time> Timestamp of when analysis was last modified. |
appliedDimensions | Array of strings List of applied dimensions name. |
aggregationPeriod | string (apiAggregationPeriod) Enum: "AGGREGATION_PERIOD_HOURLY" "AGGREGATION_PERIOD_DAILY" "AGGREGATION_PERIOD_WEEKLY" "AGGREGATION_PERIOD_MONTHLY" "AGGREGATION_PERIOD_ANNUALLY" |
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "name": "string",
- "id": 0,
- "timeDimensionName": "string",
- "filterExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "metricId": 0,
- "timeRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "groupAName": "string",
- "groupBName": "string",
- "groupAExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "groupBExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "projectId": 0,
- "type": "ANALYSIS_TYPE_GENERAL_PERFORMANCE",
- "createdAt": "2019-08-24T14:15:22Z",
- "applicationUrl": "string",
- "recentRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "previousRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "createdByEmail": "string",
- "lastModifiedAt": "2019-08-24T14:15:22Z",
- "lastModifiedByEmail": "string",
- "lastRun": "2019-08-24T14:15:22Z",
- "appliedDimensions": [
- "string"
], - "aggregationPeriod": "AGGREGATION_PERIOD_HOURLY"
}
Delete analysis.
Authorizations:
path Parameters
id required | string <uint64> Analysis id to be deleted. |
Responses
Response Schema: application/json
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{ }
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
optional name for the new analysis
Responses
Response Schema: application/json
id | string <uint64> Newly created Analysis id. |
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
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> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "filterExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}
}
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 (ExpressionOrExpression) 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
}
}) |
Responses
Response Schema: application/json
Response with empty message.
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Request samples
- Payload
{- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}
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> |
message | string |
Array of objects (protobufAny) |
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> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "analysisResult": {
- "id": "string",
- "runStatus": "RUN_STATUS_IN_FLIGHT",
- "requestedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "runType": "RUN_TYPE_SCHEDULED",
- "keyDriverAnalysisResult": {
- "summaryCard": {
- "metricTypeLabel": "string",
- "generalPerformanceCard": {
- "cardLabel": "string",
- "categoryFilter": "string",
- "summaryValue": 0,
- "matchSize": 0,
- "totalSize": 0,
- "min": 0,
- "max": 0,
- "median": 0,
- "average": 0,
- "weightedAverage": 0,
- "sum": 0,
- "weightedSum": 0,
- "weight": 0,
- "totalNumerator": 0,
- "totalDenominator": 0
}, - "groupComparisonCard": {
- "groupACard": {
- "cardLabel": "string",
- "categoryFilter": "string",
- "summaryValue": 0,
- "matchSize": 0,
- "totalSize": 0,
- "min": 0,
- "max": 0,
- "median": 0,
- "average": 0,
- "weightedAverage": 0,
- "sum": 0,
- "weightedSum": 0,
- "weight": 0,
- "totalNumerator": 0,
- "totalDenominator": 0
}, - "groupBCard": {
- "cardLabel": "string",
- "categoryFilter": "string",
- "summaryValue": 0,
- "matchSize": 0,
- "totalSize": 0,
- "min": 0,
- "max": 0,
- "median": 0,
- "average": 0,
- "weightedAverage": 0,
- "sum": 0,
- "weightedSum": 0,
- "weight": 0,
- "totalNumerator": 0,
- "totalDenominator": 0
}, - "groupAFilter": "string",
- "groupBFilter": "string",
- "percentChange": 0
}, - "timeComparisonCard": {
- "currentPeriodCard": {
- "cardLabel": "string",
- "categoryFilter": "string",
- "summaryValue": 0,
- "matchSize": 0,
- "totalSize": 0,
- "min": 0,
- "max": 0,
- "median": 0,
- "average": 0,
- "weightedAverage": 0,
- "sum": 0,
- "weightedSum": 0,
- "weight": 0,
- "totalNumerator": 0,
- "totalDenominator": 0
}, - "previousPeriodCard": {
- "cardLabel": "string",
- "categoryFilter": "string",
- "summaryValue": 0,
- "matchSize": 0,
- "totalSize": 0,
- "min": 0,
- "max": 0,
- "median": 0,
- "average": 0,
- "weightedAverage": 0,
- "sum": 0,
- "weightedSum": 0,
- "weight": 0,
- "totalNumerator": 0,
- "totalDenominator": 0
}, - "currentPeriod": {
- "startDateInclusive": "2019-08-24T14:15:22Z",
- "endDateInclusive": "2019-08-24T14:15:22Z"
}, - "previousPeriod": {
- "startDateInclusive": "2019-08-24T14:15:22Z",
- "endDateInclusive": "2019-08-24T14:15:22Z"
}, - "percentChange": 0
}
}, - "timeComparison": {
- "previousPeriod": {
- "startDateInclusive": "2019-08-24T14:15:22Z",
- "endDateInclusive": "2019-08-24T14:15:22Z"
}, - "recentPeriod": {
- "startDateInclusive": "2019-08-24T14:15:22Z",
- "endDateInclusive": "2019-08-24T14:15:22Z"
}
}, - "groupComparison": {
- "groupA": {
- "name": "string"
}, - "groupB": {
- "name": "string"
}
}, - "generalPerformance": { },
- "segments": [
- {
- "id": "string",
- "factors": {
- "property1": {
- "value": {
- "booleanValue": true,
- "integerValue": "string",
- "stringValue": "string",
- "floatValue": 0,
- "timestampValue": "2019-08-24T14:15:22Z"
}, - "keyword": {
- "keyword": "string"
}, - "bin": {
- "lowerBound": 0,
- "upperBound": 0,
- "lowerBoundPercentile": 0,
- "upperBoundPercentile": 0
}
}, - "property2": {
- "value": {
- "booleanValue": true,
- "integerValue": "string",
- "stringValue": "string",
- "floatValue": 0,
- "timestampValue": "2019-08-24T14:15:22Z"
}, - "keyword": {
- "keyword": "string"
}, - "bin": {
- "lowerBound": 0,
- "upperBound": 0,
- "lowerBoundPercentile": 0,
- "upperBoundPercentile": 0
}
}
}, - "groupComparison": {
- "groupASize": 0,
- "groupBSize": 0,
- "groupAValue": 0,
- "groupBValue": 0
}, - "timeComparison": {
- "previousPeriodSize": 0,
- "recentPeriodSize": 0,
- "previousPeriodValue": 0,
- "recentPeriodValue": 0
}, - "generalPerformance": {
- "size": 0,
- "value": 0
}, - "impact": 0,
- "confidence": "CONFIDENCE_LEVEL_HIGH",
- "customCalculations": {
- "property1": 0,
- "property2": 0
}
}
]
}, - "trendAnalysisResult": {
- "summaryCard": {
- "currentPeriod": {
- "cardLabel": "string",
- "slope": 0,
- "percentChange": 0,
- "denominatorLabel": "string"
}, - "previousPeriod": {
- "cardLabel": "string",
- "slope": 0,
- "percentChange": 0,
- "denominatorLabel": "string"
}
}, - "overallTrends": [
- {
- "timeRange": {
- "startDateInclusive": "2019-08-24T14:15:22Z",
- "endDateInclusive": "2019-08-24T14:15:22Z"
}, - "intercept": 0,
- "trend": 0,
- "size": 0
}
], - "segments": [
- {
- "id": "string",
- "factors": {
- "property1": {
- "value": {
- "booleanValue": true,
- "integerValue": "string",
- "stringValue": "string",
- "floatValue": 0,
- "timestampValue": "2019-08-24T14:15:22Z"
}, - "keyword": {
- "keyword": "string"
}, - "bin": {
- "lowerBound": 0,
- "upperBound": 0,
- "lowerBoundPercentile": 0,
- "upperBoundPercentile": 0
}
}, - "property2": {
- "value": {
- "booleanValue": true,
- "integerValue": "string",
- "stringValue": "string",
- "floatValue": 0,
- "timestampValue": "2019-08-24T14:15:22Z"
}, - "keyword": {
- "keyword": "string"
}, - "bin": {
- "lowerBound": 0,
- "upperBound": 0,
- "lowerBoundPercentile": 0,
- "upperBoundPercentile": 0
}
}
}, - "trends": [
- {
- "timeRange": {
- "startDateInclusive": "2019-08-24T14:15:22Z",
- "endDateInclusive": "2019-08-24T14:15:22Z"
}, - "intercept": 0,
- "trend": 0,
- "size": 0
}
], - "impact": 0
}
]
}, - "metricId": "string",
- "applicationUrl": "string",
- "resultVersion": "string",
- "statusMessage": "string"
}, - "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) | |||||||||||||
Array
|
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "waterfall": [
- {
- "cumulativeImpactBeforeStep": 0,
- "cumulativeImpactAfterStep": 0,
- "overlappingImpact": 0,
- "changeInSize": {
- "subgroupA": 0,
- "subgroupB": 0
}, - "changeInType": {
- "subgroupA": 0,
- "subgroupB": 0
}, - "factors": {
- "property1": {
- "value": {
- "booleanValue": true,
- "integerValue": "string",
- "stringValue": "string",
- "floatValue": 0,
- "timestampValue": "2019-08-24T14:15:22Z"
}, - "keyword": {
- "keyword": "string"
}, - "bin": {
- "lowerBound": 0,
- "upperBound": 0,
- "lowerBoundPercentile": 0,
- "upperBoundPercentile": 0
}
}, - "property2": {
- "value": {
- "booleanValue": true,
- "integerValue": "string",
- "stringValue": "string",
- "floatValue": 0,
- "timestampValue": "2019-08-24T14:15:22Z"
}, - "keyword": {
- "keyword": "string"
}, - "bin": {
- "lowerBound": 0,
- "upperBound": 0,
- "lowerBoundPercentile": 0,
- "upperBoundPercentile": 0
}
}
}
}
]
}
Orchestrator API to seamlessly create and run new analysis.
Authorizations:
Request Body schema: application/json
object (apiOrchestratorDataset) | |
object (apiOrchestratorMetric) | |
object (apiOrchestratorDimension) | |
object (apiOrchestratorAnalysis) |
Responses
Response Schema: application/json
name | string The name of the analysis. |
id | string <uint64> Analysis id. |
timeDimension | string The name of metric's time dimension which represents the date range of the metric. |
metricId | string <uint64> The metric id which the analysis depends on. |
projectId | string <uint64> Project id corresponding to the analysis. |
type | string (apiAnalysisType) Enum: "ANALYSIS_TYPE_GENERAL_PERFORMANCE" "ANALYSIS_TYPE_TREND" "ANALYSIS_TYPE_TIME_COMPARE" "ANALYSIS_TYPE_GROUP_COMPARE" Type of Analysis eg. KEY_DRIVER. |
createdAt | string <date-time> Timestamp when the analysis was created. |
applicationUrl | string Link to the live sisu analysis this represents. ex: vip.sisudata.com/projects/{id}/analysis/{id}. |
object (apiTimeWindow) | |
object (apiTimeWindow) | |
object (apiTimeWindow) | |
datasetId | string <uint64> ID of dataset. |
resultId | string <uint64> The analysis result id. |
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Request samples
- Payload
{- "dataset": {
- "dataSourceId": "string",
- "name": "string",
- "sql": "string",
- "id": "string"
}, - "metric": {
- "name": "string",
- "desiredDirection": "INCREASE",
- "aggregate": "AVERAGE",
- "metricDimension": "string",
- "weightDimension": "string",
- "id": "string"
}, - "dimension": {
- "useAllDimensions": true,
- "dimensionList": [
- {
- "name": "string"
}
]
}, - "analysis": {
- "projectId": "string",
- "name": "string",
- "timeDimension": "string",
- "timeCompare": {
- "recentRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "previousRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}
}, - "timeRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}
}
}
Response samples
- 200
- default
{- "name": "string",
- "id": "string",
- "timeDimension": "string",
- "metricId": "string",
- "projectId": "string",
- "type": "ANALYSIS_TYPE_GENERAL_PERFORMANCE",
- "createdAt": "2019-08-24T14:15:22Z",
- "applicationUrl": "string",
- "recentRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "previousRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "timeRange": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "datasetId": "string",
- "resultId": "string"
}
List all Metrics.
Authorizations:
Responses
Response Schema: application/json
Array of objects (apiMetric) | |||||||||||||||||||||||
Array
|
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "metrics": [
- {
- "id": "string",
- "name": "string",
- "weightDimensionName": "string",
- "timeDimensionName": "string",
- "desiredDirection": "DESIRED_DIRECTION_INCREASE",
- "metricDimension": {
- "name": "string",
- "value": {
- "booleanValue": true,
- "integerValue": "string",
- "stringValue": "string",
- "floatValue": 0,
- "timestampValue": "2019-08-24T14:15:22Z"
}
}, - "kpiUnitsConfig": {
- "type": "UNIT_TYPE_CUSTOM",
- "label": "string",
- "scale": 0,
- "precision": 0,
- "currency": "string",
- "kmb": true
}, - "type": "METRIC_TYPE_AVERAGE",
- "createdAt": "2019-08-24T14:15:22Z",
- "datasetId": "string",
- "excelFormat": "string"
}
]
}
Get a metric for a given id.
Authorizations:
path Parameters
id required | string <int64> |
Responses
Response Schema: application/json
id | string <uint64> Metric id. |
name | string Metric name. |
object (apiGetMetricResponseTimeDimension) Time dimension in a metric. | |
object (apiGetMetricResponseWeightDimension) Weight dimension in a metric. | |
desiredDirection | string (MetricDesiredDirection) Enum: "DESIRED_DIRECTION_INCREASE" "DESIRED_DIRECTION_DECREASE" Type of metric direction. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiGetMetricResponseMetricDimension) A dimension in a metric. | |
object (apiUnitsConfig) | |
type | string (MetricMetricType) Enum: "METRIC_TYPE_AVERAGE" "METRIC_TYPE_SUM" "METRIC_TYPE_WEIGHTED_SUM" "METRIC_TYPE_WEIGHTED_AVERAGE" "METRIC_TYPE_CATEGORICAL_COUNT" "METRIC_TYPE_CATEGORICAL_RATE" "METRIC_TYPE_COUNT_DISTINCT" "METRIC_TYPE_NUMERICAL_COUNT" "METRIC_TYPE_NUMERICAL_RATE" Type of metric calculation that is used to evaluate the metric's dimension.
|
createdAt | string <date-time> Timestamp when the metric was created. |
createdByEmail | string Email ID of a user who created this metric. |
datasetId | string <uint64> ID of the metric data set. |
datasetName | string Name of the metric data set. |
dataSourceId | string <uint64> ID of the metric data source. |
dataSourceName | string Name of the metric data source. |
lastModifiedAt | string <date-time> Timestamp when the metric was last modified. |
lastModifiedByEmail | string Email ID of a user last modified this metric. |
queryName | string Saved query name used when the metric was created. |
verifiedAt | string <date-time> Timestamp when the metric was verified. |
verifiedByEmail | string Email ID of a user who verified this metric. |
excelFormat | string Excel format of the looker created metric. |
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "id": "string",
- "name": "string",
- "timeDimension": {
- "name": "string",
- "id": "string"
}, - "weightDimension": {
- "name": "string",
- "id": "string"
}, - "desiredDirection": "DESIRED_DIRECTION_INCREASE",
- "filterExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "metricDimension": {
- "name": "string",
- "value": {
- "booleanValue": true,
- "integerValue": "string",
- "stringValue": "string",
- "floatValue": 0,
- "timestampValue": "2019-08-24T14:15:22Z"
}, - "id": "string",
- "includeNull": true
}, - "kpiUnitsConfig": {
- "type": "UNIT_TYPE_CUSTOM",
- "label": "string",
- "scale": 0,
- "precision": 0,
- "currency": "string",
- "kmb": true
}, - "type": "METRIC_TYPE_AVERAGE",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdByEmail": "string",
- "datasetId": "string",
- "datasetName": "string",
- "dataSourceId": "string",
- "dataSourceName": "string",
- "lastModifiedAt": "2019-08-24T14:15:22Z",
- "lastModifiedByEmail": "string",
- "queryName": "string",
- "verifiedAt": "2019-08-24T14:15:22Z",
- "verifiedByEmail": "string",
- "excelFormat": "string"
}
Delete a metric for a given metric id.
Authorizations:
path Parameters
id required | string <int64> |
Responses
Response Schema: application/json
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{ }
Update metric by metric id.
Authorizations:
path Parameters
id required | string <uint64> Metric id. |
query Parameters
datasetId | string <uint64> Dataset id of a metric. |
desiredDirection | string Enum: "DESIRED_DIRECTION_INCREASE" "DESIRED_DIRECTION_DECREASE" Specifies whether the metric's goal is to increase or decrease the kpi value. |
filterExpression.basicCondition.operator | string Enum: "OPERATOR_LT" "OPERATOR_EQ" "OPERATOR_LTE" "OPERATOR_GTE" "OPERATOR_GT" "OPERATOR_NE" "OPERATOR_LIKE" "OPERATOR_NOT_LIKE" "OPERATOR_IS" "OPERATOR_IS_NOT" |
filterExpression.basicCondition.dimensionName | string A SQL identifier name, e.g 'my_column' |
filterExpression.basicCondition.literal.bool | boolean |
filterExpression.basicCondition.literal.int | string <int64> |
filterExpression.basicCondition.literal.string | string |
filterExpression.basicCondition.literal.float | number <double> |
filterExpression.basicCondition.literal.timestamp | string <date-time> |
includeNull | boolean Include NULL values. |
isVerified | boolean Specifies whether the metric is verified or not. |
metricDimension.name | string The name of the dimension. |
metricDimension.value.booleanValue | boolean |
metricDimension.value.integerValue | string <int64> |
metricDimension.value.stringValue | string |
metricDimension.value.floatValue | number <double> |
metricDimension.value.timestampValue | string <date-time> |
kpiUnitsConfig.type | string Enum: "UNIT_TYPE_CUSTOM" "UNIT_TYPE_PERCENT" "UNIT_TYPE_CURRENCY" "UNIT_TYPE_BPS" "UNIT_TYPE_NUMBER" |
kpiUnitsConfig.label | string |
kpiUnitsConfig.scale | integer <int32> |
kpiUnitsConfig.precision | integer <int32> |
kpiUnitsConfig.currency | string |
kpiUnitsConfig.kmb | boolean |
metricType | string Enum: "METRIC_TYPE_AVERAGE" "METRIC_TYPE_SUM" "METRIC_TYPE_WEIGHTED_SUM" "METRIC_TYPE_WEIGHTED_AVERAGE" "METRIC_TYPE_CATEGORICAL_COUNT" "METRIC_TYPE_CATEGORICAL_RATE" "METRIC_TYPE_COUNT_DISTINCT" "METRIC_TYPE_NUMERICAL_COUNT" "METRIC_TYPE_NUMERICAL_RATE" Type of metric calculation.
|
name | string Metric name. |
timeDimensionName | string The name of metric's time dimension which represents the date range of the metric. |
weightDimensionName | string The name of the weight dimension. A weight dimension is used to increases the importance of a given row in an analysis. |
Responses
Response Schema: application/json
id | string <uint64> Metric id. |
name | string Metric name. |
object (apiUpdateMetricResponseTimeDimension) Time dimension in a metric. | |
object (apiUpdateMetricResponseWeightDimension) Weight dimension in a metric. | |
desiredDirection | string (MetricDesiredDirection) Enum: "DESIRED_DIRECTION_INCREASE" "DESIRED_DIRECTION_DECREASE" Type of metric direction. |
object (apiExpression) An Expression which would facilitate building a filter expression. | |
object (apiUpdateMetricResponseMetricDimension) A dimension in a metric. | |
object (apiUnitsConfig) | |
type | string (MetricMetricType) Enum: "METRIC_TYPE_AVERAGE" "METRIC_TYPE_SUM" "METRIC_TYPE_WEIGHTED_SUM" "METRIC_TYPE_WEIGHTED_AVERAGE" "METRIC_TYPE_CATEGORICAL_COUNT" "METRIC_TYPE_CATEGORICAL_RATE" "METRIC_TYPE_COUNT_DISTINCT" "METRIC_TYPE_NUMERICAL_COUNT" "METRIC_TYPE_NUMERICAL_RATE" Type of metric calculation that is used to evaluate the metric's dimension.
|
createdAt | string <date-time> Timestamp when the metric was created. |
createdByEmail | string Email ID of a user who created this metric. |
datasetId | string <uint64> ID of the metric data set. |
datasetName | string Name of the metric data set. |
dataSourceId | string <uint64> ID of the metric data source. |
dataSourceName | string Name of the metric data source. |
lastModifiedAt | string <date-time> Timestamp when the metric was last modified. |
lastModifiedByEmail | string Email ID of a user last modified this metric. |
queryName | string Saved query name used when the metric was created. |
verifiedAt | string <date-time> Timestamp when the metric was verified. |
verifiedByEmail | string Email ID of a user who verified this metric. |
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "id": "string",
- "name": "string",
- "timeDimension": {
- "name": "string",
- "id": "string"
}, - "weightDimension": {
- "name": "string",
- "id": "string"
}, - "desiredDirection": "DESIRED_DIRECTION_INCREASE",
- "filterExpression": {
- "and": {
- "expressions": [
- { }
]
}, - "or": {
- "expressions": [
- { }
]
}, - "basicCondition": {
- "operator": "OPERATOR_LT",
- "dimensionName": "string",
- "nullLiteral": { },
- "literal": {
- "bool": true,
- "int": "string",
- "string": "string",
- "float": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
}
}, - "metricDimension": {
- "name": "string",
- "value": {
- "booleanValue": true,
- "integerValue": "string",
- "stringValue": "string",
- "floatValue": 0,
- "timestampValue": "2019-08-24T14:15:22Z"
}, - "id": "string",
- "includeNull": true
}, - "kpiUnitsConfig": {
- "type": "UNIT_TYPE_CUSTOM",
- "label": "string",
- "scale": 0,
- "precision": 0,
- "currency": "string",
- "kmb": true
}, - "type": "METRIC_TYPE_AVERAGE",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdByEmail": "string",
- "datasetId": "string",
- "datasetName": "string",
- "dataSourceId": "string",
- "dataSourceName": "string",
- "lastModifiedAt": "2019-08-24T14:15:22Z",
- "lastModifiedByEmail": "string",
- "queryName": "string",
- "verifiedAt": "2019-08-24T14:15:22Z",
- "verifiedByEmail": "string"
}
List all data sets.
Authorizations:
Responses
Response Schema: application/json
Array of objects (v1apiDataset) | |||||||||||||||
Array
|
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "datasets": [
- {
- "id": "string",
- "name": "string",
- "datasetType": "DATASET_TYPE_TABLE",
- "queryString": "string",
- "lastModified": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "dataSourceId": "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) | |||||||
Array
|
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "dimensions": [
- {
- "name": "string",
- "datasetId": "string",
- "dimensionType": "SQL_DATA_TYPE_STRING"
}
]
}
Get data source.
Authorizations:
path Parameters
id required | string <uint64> Dataset id. |
Responses
Response Schema: application/json
id | string <uint64> Dataset id. |
name | string The table name for DATASET_TYPE_TABLE or user-defined for DATASET_TYPE_QUERY. |
datasetType | string (DatasetDatasetType) Enum: "DATASET_TYPE_TABLE" "DATASET_TYPE_QUERY"
|
queryString | string A SQL query string for a dataset of type query. |
lastModifiedAt | string <date-time> Last time the data set was modified. |
createdAt | string <date-time> Time when the data set was created. |
dataSourceId | string <uint64> Data Source id of the data set. |
dataSource | string The name of data source. |
lastModifiedByEmail | string The last modified by email. |
associatedCountAnalyses | string <uint64> The associated analyses count of the dataset. |
associatedCountExplorations | string <uint64> The associated explorations count of the dataset. |
associatedCountMetrics | string <uint64> The associated metrics count of the dataset. |
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "id": "string",
- "name": "string",
- "datasetType": "DATASET_TYPE_TABLE",
- "queryString": "string",
- "lastModifiedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "dataSourceId": "string",
- "dataSource": "string",
- "lastModifiedByEmail": "string",
- "associatedCountAnalyses": "string",
- "associatedCountExplorations": "string",
- "associatedCountMetrics": "string"
}
Delete dataset.
Authorizations:
path Parameters
id required | string <uint64> Dataset id to be deleted. |
Responses
Response Schema: application/json
Response for delete dataset.
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{ }
List all data sources.
Authorizations:
Responses
Response Schema: application/json
Array of objects (apiDataSource) | |||||||||||||
Array
|
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "dataSources": [
- {
- "id": "string",
- "name": "string",
- "dataSourceType": "DATA_SOURCE_TYPE_REDSHIFT",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "connectionUri": "string"
}
]
}
Get data source.
Authorizations:
path Parameters
id required | string <uint64> Data source id. |
Responses
Response Schema: application/json
id | string <uint64> The id of data source. |
name | string The table or query name of a data source. |
dataSourceType | string The type of data source. |
connectionUri | string The JDBC connection URI to the data source location. |
dataSourceUsername | string The username of the data source. |
private | boolean The data source is private or not. |
createdAt | string <date-time> The created timestamp of data source. |
createdBy | string The creates of data source. |
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "id": "string",
- "name": "string",
- "dataSourceType": "string",
- "connectionUri": "string",
- "dataSourceUsername": "string",
- "private": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string"
}
Delete data source.
Authorizations:
path Parameters
id required | string <uint64> Data source id to be deleted. |
Responses
Response Schema: application/json
Response payload for delete data source.
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{ }
Modify data source.
Authorizations:
path Parameters
id required | string <uint64> The id of data source. |
Request Body schema: application/json
name | string The table or query name of a data source. |
password | string The password of data source. |
uri | string The JDBC connection URI to the data source location. |
username | string The username of the data source. |
isRestricted | boolean The data source is private or not. |
Responses
Response Schema: application/json
id | string <uint64> The id of data source. |
name | string The table or query name of a data source. |
dataSourceType | string The type of data source. |
connectionUri | string The JDBC connection URI to the data source location. |
dataSourceUsername | string The username of the data source. |
private | boolean The data source is private or not. |
createdAt | string <date-time> The created timestamp of data source. |
createdBy | string The creates of data source. |
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Request samples
- Payload
{- "name": "string",
- "password": "string",
- "uri": "string",
- "username": "string",
- "isRestricted": true
}
Response samples
- 200
- default
{- "id": "string",
- "name": "string",
- "dataSourceType": "string",
- "connectionUri": "string",
- "dataSourceUsername": "string",
- "private": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "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> |
message | string |
Array of objects (protobufAny) |
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> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "queryString": "string"
}
Get project details for a given project id
Authorizations:
path Parameters
id required | string <int64> |
Responses
Response Schema: application/json
id | string <uint64> Project id. |
name | string Project name. |
description | string Project description. |
createdAt | string <date-time> Timestamp when the Project was created. |
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "id": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
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) List of analyses associated with a project. | |||||||||||||||
Array
|
Response Schema: application/json
code | integer <int32> |
message | string |
Array of objects (protobufAny) |
Response samples
- 200
- default
{- "analyses": [
- {
- "id": "string",
- "name": "string",
- "type": "ANALYSIS_TYPE_GENERAL_PERFORMANCE",
- "createdAt": "2019-08-24T14:15:22Z",
- "metricId": "string",
- "projectId": "string",
- "applicationUrl": "string"
}
]
}