Analytics¶
This page outlines the operations, endpoints, parameters, and example requests and responses for the Analytics.
GET /api/v2/eventLogs/¶
Retrieve one page of audit log records.
Code samples¶
# You can also use wget
curl -X GET http://10.97.88.31/api/v2/eventLogs/ \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
projectId | query | string | false | The project to select log records for. |
userId | query | string | false | The user to select log records for. |
orgId | query | string | false | The organization to select log records for. |
event | query | string | false | The event type of records. |
minTimestamp | query | string(date-time) | false | The lower bound for timestamps. E.g. '2016-12-13T11:12:13.141516Z'. |
maxTimestamp | query | string(date-time) | false | The upper bound for timestamps. E.g. '2016-12-13T11:12:13.141516Z'. |
offset | query | integer | false | This many results will be skipped. Defaults to 0. |
order | query | string | false | The order of the results. Defaults to descending. |
includeIdentifyingFields | query | string | false | Indicates if identifying information like user names, project names, etc. should be included or not. Defaults to True. |
auditReportType | query | string | false | Indicates which type of event to return - must be one of APP_USAGE for application related events (i.e. Project Created, Dataset Uploaded, etc.) or ADMIN_USAGE for admin related events (i.e. Reset API Token for User, Organization Created, etc.). If not provided, all events will be returned by default. |
Enumerated Values¶
Parameter | Value |
---|---|
event | ADLS OAuth Failed |
event | ADLS OAuth Token Obtained |
event | ADLS OAuth Token Renewal Succeeded |
event | ADLS OAuth User Login Started |
event | ADLS OAuth User Login Succeeded |
event | API Key Created |
event | API Key Deleted |
event | API Key Updated |
event | Abort Autopilot |
event | Access request created |
event | Activate account |
event | Activated On First Login |
event | Actuals Uploaded |
event | Add Model |
event | Add New Dataset For Predictions |
event | Add SAML configuration |
event | Advanced Tuning Requested |
event | App Config Changed |
event | Approval Workflow Policy Action |
event | Approval Workflow Policy Created |
event | Approval Workflow Policy Deleted |
event | Approval Workflow Policy Updated |
event | Approve account |
event | Association ID Set |
event | Automated Application Access Revoked from the Group |
event | Automated Application Access Revoked from the Organization |
event | Automated Application Access Revoked from the User |
event | Automated Application Created |
event | Automated Application Deleted |
event | Automated Application Domain Prefix Changed |
event | Automated Application Duplicated |
event | Automated Application Shared |
event | Automated Application Shared with Group |
event | Automated Application Shared with Organization |
event | Automated Application Upgraded |
event | Automated Demo Application Created |
event | Automated Document Created |
event | Automated Document Deleted |
event | Automated Document Downloaded |
event | Automated Document Previewed |
event | Automated Document Requested |
event | Available Forecast Points Computation Job Started |
event | Base Image Built |
event | Batch Prediction Created from Dataset |
event | Batch prediction job aborted |
event | Batch prediction job completed |
event | Batch prediction job created |
event | Batch prediction job failed |
event | Batch prediction job started |
event | Bias And Fairness Cross Class Calculated |
event | Bias And Fairness Insights Calculated |
event | Bias And Fairness Per Class Calculated |
event | Bias and Fairness monitoring settings updated. |
event | Bias and Fairness protected features specified. |
event | Blending Models Limit Exceeded |
event | Bulk Datasets Deleted |
event | Bulk Datasets Tags Appended |
event | CCM Balancer Terminated |
event | CCM CLUSTER Reprovisioned |
event | CCM Cluster Created |
event | CCM Cluster Terminated |
event | CCM Resource Group Created |
event | Calculation of prediction intervals is requested |
event | Challenger Insight Generation Started |
event | Challenger Model Created |
event | Challenger Model Deleted |
event | Challenger Model Promoted |
event | Challenger Models Disabled |
event | Challenger Models Enabled |
event | Change Request Cancelled |
event | Change Request Created |
event | Change Request Reopened |
event | Change Request Resolved |
event | Change Request Review Added |
event | Change Request Updated |
event | Change password |
event | Child Entity Associated With Workspace In AI Catalog |
event | Child Entity Disassociated From Workspace In AI Catalog |
event | Clustering Cluster Names Updated |
event | Comment Created |
event | Comment Deleted |
event | Comment Updated |
event | Completed Feature Discovery Secondary Datasets |
event | Completed Feature Discovery for Primary Dataset |
event | Compliance Doc Deleted |
event | Compliance Doc Downloaded |
event | Compliance Doc Generated |
event | Compliance Doc Previewed |
event | Compute Cluster Added |
event | Compute Cluster Deleted |
event | Compute Cluster Updated |
event | Compute External Insights |
event | Compute Reason Codes |
event | Create account |
event | Created dataset from Data Engine workspace |
event | Created dataset version from Data Engine workspace |
event | Credential Created |
event | Credential Deleted |
event | Credential Updated |
event | Credential Values Retrieved Based On OAuth Configuration ID |
event | Custom Application Access Revoked from the Organization |
event | Custom Application Access Revoked from the User |
event | Custom Application Shared with Group |
event | Custom Application Shared with Organization |
event | Custom Application Shared with User |
event | Custom Metric Bulk Upload Succeeded |
event | Custom Metric Creation Succeeded |
event | Custom Metric Dataset Upload Succeeded |
event | Custom Metric JSON Upload Succeeded |
event | Custom Model Conversion Failed |
event | Custom Model Conversion Files Uploaded |
event | Custom Model Conversion Succeeded |
event | Custom RBAC Access Role Created |
event | Custom RBAC Access Role Deleted |
event | Custom RBAC Access Role Updated |
event | Custom Registered Model Created |
event | Custom Registered Model Version Added |
event | Custom Task Deploy |
event | Custom Task Fit |
event | Custom inference model added |
event | Custom inference model assign training data request received |
event | Custom inference model updated |
event | Custom inference model version assign training data request received |
event | Custom model item added |
event | Custom task added |
event | Custom task updated |
event | Custom task version added |
event | Data Connection Created |
event | Data Connection Deleted |
event | Data Connection Tested |
event | Data Connection Updated |
event | Data Matching ANN Index Profile Built |
event | Data Matching Query Requested |
event | Data Sample Queried For Wrangling |
event | Data Source is created |
event | Data Sources Permadelete Executed |
event | Data Sources Permadelete Failed |
event | Data Sources Permadelete Submitted |
event | Data Store Config Request Submitted |
event | Data Stores Permadelete Executed |
event | Data Stores Permadelete Failed |
event | Data Stores Permadelete Submitted |
event | Data engine query generator created |
event | Data engine query generator deleted |
event | Data engine workspace created |
event | Data engine workspace deleted |
event | Data engine workspace state previewed |
event | Data engine workspace updated |
event | Dataset Categories Modified |
event | Dataset Column Aliases Modified |
event | Dataset Created |
event | Dataset Deleted |
event | Dataset Description Modified |
event | Dataset Download |
event | Dataset Materialized |
event | Dataset Name Modified |
event | Dataset Reloaded |
event | Dataset Shared |
event | Dataset Sharing Removed |
event | Dataset Tags Modified |
event | Dataset Undeleted |
event | Dataset Upload |
event | Dataset Upload is Completed |
event | Dataset Version Deleted |
event | Dataset Version Undeleted |
event | Dataset featurelist created |
event | Dataset featurelist deleted |
event | Dataset featurelist updated |
event | Dataset for predictions with actual value column processed |
event | Dataset refresh job created |
event | Dataset refresh job deleted |
event | Dataset refresh job updated |
event | Dataset relationship created |
event | Dataset relationship updated |
event | Dataset transform created |
event | Datasets Permadelete Executed |
event | Datasets Permadelete Failed |
event | Datasets Permadelete Submitted |
event | Deactivate Account |
event | Decision Flow Created |
event | Decision Flow Model Package Created |
event | Decision Flow Test Downloaded |
event | Decision Flow Version Created |
event | Decision Flow Version Deleted |
event | Default value for Do-Not-Derive is changed |
event | Delete SAML configuration |
event | Deny account |
event | Deploy Model To Hadoop |
event | Deployment Activated |
event | Deployment Actuals Export Created |
event | Deployment Added |
event | Deployment Deactivated |
event | Deployment Deleted |
event | Deployment Humility Rule Added |
event | Deployment Humility Rule Deleted |
event | Deployment Humility Rule Submitted |
event | Deployment Humility Rule Updated |
event | Deployment Humility Setting Updated |
event | Deployment Monitoring Batch Created |
event | Deployment Monitoring Timeliness Setting Changed |
event | Deployment Permanently Erased |
event | Deployment Statistics Reset |
event | Deployment prediction export created |
event | Deployment prediction warning setting updated |
event | Deployment training data export created |
event | Detected Data Quality: Disguised Missing Values |
event | Detected Data Quality: Excess Zero |
event | Detected Data Quality: Imputation Leakage |
event | Detected Data Quality: Inconsistent Gaps |
event | Detected Data Quality: Inliers |
event | Detected Data Quality: Lagged Features |
event | Detected Data Quality: Leading or Trailing Series |
event | Detected Data Quality: Missing Documents |
event | Detected Data Quality: Missing Images |
event | Detected Data Quality: Multicategorical Invalid Format |
event | Detected Data Quality: New Series in Recent Data |
event | Detected Data Quality: Outliers |
event | Detected Data Quality: Quantile Target Sparsity |
event | Detected Data Quality: Quantile Target Zero Inflation |
event | Detected Data Quality: Target Leakage |
event | Detected Data Quality: Target had infrequent negative values |
event | Do-Not-Derive is used |
event | Documentation Request |
event | Download All Charts |
event | Download Chart |
event | Download Codegen |
event | Download Codegen From Deployment |
event | Download Deployment Chart |
event | Download Model |
event | Download Model Package |
event | Download Model Package From Deployment |
event | Download Predictions |
event | Empty Catalog Item Created |
event | Empty Cluster Status Created |
event | Experiment Container Created |
event | Experiment Container Dataset Registered |
event | Experiment Container Dataset Unregistered |
event | Experiment Container Deleted |
event | Experiment Container Entity Linked |
event | Experiment Container Entity Unlinked |
event | Experiment Container Updated |
event | External Predictions Configured |
event | External Registered Model Created |
event | External Registered Model Version Added |
event | FEAR Predict Job Started |
event | Failed Decision Flow Test |
event | Feature Discovery Relationship Quality Assessment Inputs Metrics |
event | Feature Discovery Relationship Quality Assessment Warnings Metrics |
event | Feature Over Geo Computed |
event | Finish Autopilot |
event | First Login After DR Account Migration |
event | General Feedback Submitted |
event | Geometry Over Geo Computed |
event | Geospatial Feature Transform Created |
event | Geospatial Primary Location Column Selected |
event | Global SAML Configuration Added |
event | Global SAML Configuration Deleted |
event | Global SAML Configuration Updated |
event | Group Members Updated |
event | Group created |
event | Group deleted |
event | Group updated |
event | Interaction Feature Created |
event | Interaction Feature Deployment Created |
event | Invitation Accepted |
event | Invitation sent |
event | Job definition created |
event | Job definition updated |
event | Login Fail |
event | Login Succeeded Via Global SAML SSO |
event | Login Success Via SAML SSO |
event | Login Successful |
event | Logout |
event | MLOps Installer Download Request Received |
event | Managed Image Built |
event | Model Deployment Shared |
event | Model Insights Job Submitted |
event | Models Starred |
event | Multi-Factor Auth Disable |
event | Multi-Factor Auth Enable |
event | Multilabel Labelwise ROC With Missing TPR Or FPR Requested |
event | Native Registered Model Created |
event | Native Registered Model Version Added |
event | No predictors are left because of Do-Not-Derive |
event | Non Existent Value Tracker Attachment Removed |
event | Notebook Created |
event | Notebook Deleted |
event | Notebook Environment Variable Deleted |
event | Notebook Environment Variable Edited |
event | Notebook Environment Variables Created |
event | Notebook Environment Variables Deleted |
event | Notebook Metadata Edited |
event | Notebook Revision Created |
event | Notebook Revision Deleted |
event | Notebook Revision Restored |
event | Notebook Schedule Created |
event | Notebook Schedule Deleted |
event | Notebook Session Started |
event | Notebook Session Stopped |
event | Notification channel created |
event | Notification channel deleted |
event | Notification channel updated |
event | Notification policy created |
event | Notification policy deleted |
event | Notification policy updated |
event | Number of bias mitigation jobs on Autopilot stage. |
event | Online Conformal PI Calculation Requested |
event | Organization Perma-Deletion Completed |
event | Organization Perma-Deletion Failed |
event | Organization Perma-Deletion Marked |
event | Organization Perma-Deletion Requested |
event | Organization Perma-Deletion Started |
event | Organization Perma-Deletion Unmarked |
event | Organization created |
event | Organization deleted |
event | Organization updated |
event | Organizations Perma-Deletion Requested |
event | PPS Docker Image Download Request Received |
event | Period accuracy file validation failed |
event | Period accuracy file validation successful |
event | Period accuracy insight computed |
event | Pipeline downsampling build and run started. |
event | Pipeline downsampling run failed to start. |
event | PredictionIntegrationJob Completed |
event | PredictionIntegrationJob Created |
event | PredictionIntegrationJob Deleted |
event | PredictionIntegrationJob Failed |
event | PredictionIntegrationJob Updated |
event | Predictions by Forecast Date Settings Updated |
event | Prime Downloaded |
event | Prime Run |
event | Project Access Revoked from the Group |
event | Project Access Revoked from the Organization |
event | Project Access Revoked from the User |
event | Project Autopilot Configured |
event | Project Cloned |
event | Project Created |
event | Project Created from Dataset |
event | Project Created from Project Export File |
event | Project Created from Wrangled Dataset |
event | Project Deleted |
event | Project Description Updated |
event | Project Exported as Project Export File |
event | Project Options Retrieved |
event | Project Options Updated |
event | Project Permadelete Executed |
event | Project Permadelete Failed |
event | Project Permadelete Submitted |
event | Project Renamed |
event | Project Restored |
event | Project Shared |
event | Project Shared with Group |
event | Project Shared with Organization |
event | Project Target Selected |
event | Published Recipe Data Uploaded |
event | Rate limit user group changed |
event | Recipe Access Revoked from Group |
event | Recipe Access Revoked from Organization |
event | Recipe Access Revoked from User |
event | Recipe Created |
event | Recipe Published |
event | Recipe Shared |
event | Recipe Shared with Group |
event | Recipe Shared with Organization |
event | Registered Model Shared |
event | Registered Model Updated |
event | Registered Model Version Updated |
event | Replaced Model |
event | Request External Insights |
event | Request External Insights - All Datasets |
event | Request Model Insights |
event | Restart Autopilot |
event | Restore Reduced Features |
event | Retraining Policy Cancelled |
event | Retraining Policy Created |
event | Retraining Policy Deleted |
event | Retraining Policy Failed |
event | Retraining Policy Started |
event | Retraining Policy Succeeded |
event | RuleFit Code Downloaded |
event | SHAP Impact Computed |
event | SHAP Matrix Computed |
event | SHAP Predictions Explanations Computed |
event | SHAP Predictions Explanations Preview Computed |
event | SHAP Training Predictions Explanations Computed |
event | Secure Configuration Created |
event | Secure Configuration Deleted |
event | Secure Configuration Shared |
event | Secure Configuration Sharing Removed |
event | Secure Configuration Values Updated |
event | Segment Analysis Enabled |
event | Segment Attributes Specified |
event | Select Model Metric |
event | Start Autopilot |
event | Successful Decision Flow Test |
event | Successful Login using OIDC flow |
event | Successful Login using OIDC token exchange |
event | Successful Login via Google Idp |
event | Target is set as Do-Not-Derive |
event | Text prediction explanations computed |
event | Train Model |
event | Unsupervised Mode Started |
event | Update SAML configuration |
event | Update account |
event | User Agreement Accepted |
event | User Agreement Declined |
event | User Append Columns Download With Predictions |
event | User Blueprint Added To Repository |
event | User Blueprint Created |
event | User Blueprint Deleted |
event | User Blueprint Deleted In Bulk |
event | User Blueprint Description Modified |
event | User Blueprint Name Modified |
event | User Blueprint Retrieved |
event | User Blueprint Tags Modified |
event | User Blueprint Tasks Retrieved |
event | User Blueprint Updated |
event | User Blueprint Validated |
event | User Blueprints Listed |
event | User Provisioned From JWT |
event | Users Perma-Deletion Canceled |
event | Users Perma-Deletion Canceling |
event | Users Perma-Deletion Completed |
event | Users Perma-Deletion Failed |
event | Users Perma-Deletion Preview Building Canceled |
event | Users Perma-Deletion Preview Building Canceling |
event | Users Perma-Deletion Preview Building Completed |
event | Users Perma-Deletion Preview Building Failed |
event | Users Perma-Deletion Preview Building Started |
event | Users Perma-Deletion Preview Building Submitted |
event | Users Perma-Deletion Started |
event | Users Perma-Deletion Submitted |
event | Value Tracker Attachment Added |
event | Value Tracker Attachment Removed |
event | Value Tracker Created |
event | Value Tracker Stage Changed |
event | Value Tracker Updated |
event | Workspace Description Modified |
event | Workspace Marked As Deleted In AI Catalog |
event | Workspace Modified |
event | Workspace Name Modified |
event | Workspace Registered In AI Catalog |
event | Workspace Scheduled Batch Run Failed |
event | Workspace Scheduled Batch Run Started |
event | Workspace Scheduled Batch Run Succeeded |
event | Workspace Tags Modified |
event | Workspace scheduled batch processing job created |
event | Workspace scheduled batch processing job deleted |
event | Workspace scheduled batch processing job updated |
event | aiAPI Portal Login |
order | asc |
order | desc |
includeIdentifyingFields | false |
includeIdentifyingFields | False |
includeIdentifyingFields | true |
includeIdentifyingFields | True |
auditReportType | APP_USAGE |
auditReportType | ADMIN_USAGE |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"context": {
"orgId": "string",
"orgName": "string",
"projectName": "string",
"projectType": "string",
"userProjectRole": "string"
},
"event": "string",
"id": "string",
"ip": "string",
"projectId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A list of audit log records. | AuditLogsRetrieveResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/eventLogs/events/¶
Retrieve all the available events. DEPRECATED API.
Code samples¶
# You can also use wget
curl -X GET http://10.97.88.31/api/v2/eventLogs/events/ \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Example responses¶
200 Response
{
"count": 0,
"data": [
"string"
]
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A list of events. | AuditLogsEventListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/eventLogs/predictionUsage/¶
Retrieve prediction usage data. CAN_ACCESS_USER_ACTIVITY
permission is required.
Code samples¶
# You can also use wget
curl -X GET http://10.97.88.31/api/v2/eventLogs/predictionUsage/?minTimestamp=2019-08-24T14%3A15%3A22Z&maxTimestamp=2019-08-24T14%3A15%3A22Z \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
projectId | query | string | false | The project to retrieve prediction usage for. |
userId | query | string | false | The user to retrieve prediction usage for. |
minTimestamp | query | string(date-time) | true | The lower bound for timestamps. E.g. '2016-12-13T11:12:13.141516Z'. |
maxTimestamp | query | string(date-time) | true | The upper bound for timestamps. Time range should not exceed 24 hours. E.g. '2016-12-13T11:12:13.141516Z'. |
order | query | string | false | The order of prediction usage rows sorted by timestamp . Defaults to descending. |
offset | query | integer | false | This many results will be skipped. Defaults to 0. |
includeIdentifyingFields | query | string | false | Indicates if identifying information like user names, project names, etc should be included or not. Defaults to True. |
Enumerated Values¶
Parameter | Value |
---|---|
order | asc |
order | desc |
includeIdentifyingFields | false |
includeIdentifyingFields | False |
includeIdentifyingFields | true |
includeIdentifyingFields | True |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"avgExecutionTime": 0,
"blenderModelTypes": "string",
"datasetId": "string",
"deploymentId": "string",
"deploymentType": "string",
"groupId": "string",
"groupName": "string",
"modelId": "string",
"modelType": "string",
"orgId": "string",
"orgName": "string",
"predictionExplanations": true,
"predictionMethod": "string",
"predictionRowCountPerMinute": [
0
],
"predictionRowsCount": 0,
"projectId": "string",
"projectType": "string",
"pythonVersion": "string",
"recommendedModel": true,
"requestCountPerMinute": [
0
],
"requestsCount": 0,
"serverErrorCount": 0,
"timestamp": "2019-08-24T14:15:22Z",
"userErrorCount": 0,
"userId": "string",
"userProjectRole": "string",
"username": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A list of prediction events. | PredictionUsageRetrieveResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/eventLogs/{recordId}/¶
Get audit record by ID.
Code samples¶
# You can also use wget
curl -X GET http://10.97.88.31/api/v2/eventLogs/{recordId}/ \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
includeIdentifyingFields | query | string | false | Indicates if identifying information like user names, project names, etc should be included or not. Defaults to True. |
recordId | path | string | true | The id of the audit log. |
Enumerated Values¶
Parameter | Value |
---|---|
includeIdentifyingFields | false |
includeIdentifyingFields | False |
includeIdentifyingFields | true |
includeIdentifyingFields | True |
Example responses¶
200 Response
{
"context": {
"orgId": "string",
"orgName": "string",
"projectName": "string",
"projectType": "string",
"userProjectRole": "string"
},
"event": "string",
"id": "string",
"ip": "string",
"projectId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The queried audit record. | AuditLogsRetrieveOneResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/usageDataExports/¶
Create a customer usage data artifact request. Requires "CAN_ACCESS_USER_ACTIVITY" permission. Returns async task status URL as a "Location" header. Async task status should be polled in order to retrieve artifact id.
Code samples¶
# You can also use wget
curl -X POST http://10.97.88.31/api/v2/usageDataExports/ \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'
Body parameter¶
{
"end": "2019-08-24T14:15:22Z",
"include": [
"string"
],
"includeIdentifyingFields": true,
"includeReport": [
"ADMIN_USAGE"
],
"noCache": true,
"projectId": "string",
"start": "2019-08-24T14:15:22Z",
"userId": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | UsageDataExport | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Customer usage data artifact creation started. Status can be tracked at Location field in headers. | None |
400 | Bad Request | Artifact creation process encountered a problem. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/usageDataExports/supportedEvents/¶
Describe supported available audit events with which to filter result data.
Code samples¶
# You can also use wget
curl -X GET http://10.97.88.31/api/v2/usageDataExports/supportedEvents/ \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Example responses¶
200 Response
{
"data": "ADLS OAuth Failed"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A list of supported available audit events. | UsageDataEventsListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/usageDataExports/{artifactId}/¶
Retrieve a prepared customer usage data artifact. Requires "CAN_ACCESS_USER_ACTIVITY" permission.
Code samples¶
# You can also use wget
curl -X GET http://10.97.88.31/api/v2/usageDataExports/{artifactId}/ \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
artifactId | path | string | true | The ID of the generated artifact to retrieve. |
Example responses¶
202 Response
{
"data": "string"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | An artifact file in .zip format. | UsageDataRetrieveResponse |
400 | Bad Request | Usage data artifact retrieval failed. | None |
404 | Not Found | Requested artifact does not exist. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/users/{userId}/rateLimitUsage/¶
Reset specified user's rate limit resource usage to zero for all resources. When windows roll over, all limits are automatically reset. Use this route to reset usage sooner.
Code samples¶
# You can also use wget
curl -X DELETE http://10.97.88.31/api/v2/users/{userId}/rateLimitUsage/ \
-H 'Authorization: Bearer {access-token}'
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
userId | path | string | true | The user identifier. |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | The usage has been successfully reset to zero. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/users/{userId}/rateLimitUsage/¶
List the rate limit resource usage for a user. The usage array returned will have one object corresponding to each rate limit applied to the user.
Code samples¶
# You can also use wget
curl -X GET http://10.97.88.31/api/v2/users/{userId}/rateLimitUsage/ \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
userId | path | string | true | The user identifier. |
Example responses¶
200 Response
{
"count": 0,
"next": "string",
"previous": "string",
"usage": [
{
"currentUsage": 0,
"maxUsage": 0,
"resource": "string",
"timeToExpire": 0
}
]
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | ResourceUsageResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/users/{userId}/rateLimitUsage/{resourceName}/¶
Reset rate limit resource usage for a user of a specified resource to zero. This will happen automatically when windows roll over. This route can be used to reset a user's rate limits sooner.
Code samples¶
# You can also use wget
curl -X DELETE http://10.97.88.31/api/v2/users/{userId}/rateLimitUsage/{resourceName}/ \
-H 'Authorization: Bearer {access-token}'
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
userId | path | string | true | The id of the user to reset usage for. |
resourceName | path | string | true | The resource name to reset usage for. |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | The usage has been successfully reset to zero. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas¶
AuditLogContextObjectResponse
{
"orgId": "string",
"orgName": "string",
"projectName": "string",
"projectType": "string",
"userProjectRole": "string"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
orgId | string¦null | false | The id of the organization. | |
orgName | string¦null | false | The name of the organization. | |
projectName | string¦null | false | The name of the project. | |
projectType | string¦null | false | The type of project. | |
userProjectRole | string¦null | false | The role of the user associated with this project. |
AuditLogsEventListResponse
{
"count": 0,
"data": [
"string"
]
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
count | integer | true | Total count of event labels. | |
data | [string] | true | A json array of event labels. |
AuditLogsRetrieveOneResponse
{
"context": {
"orgId": "string",
"orgName": "string",
"projectName": "string",
"projectType": "string",
"userProjectRole": "string"
},
"event": "string",
"id": "string",
"ip": "string",
"projectId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
context | AuditLogContextObjectResponse | true | An object with additional attributes for the record. | |
event | string | true | The record event label, e.g. 'Start Autopilot'. | |
id | string | true | The record ID. | |
ip | string¦null | false | The IP address of the server where the record event happened. Will be empty if includeIdentifyingFields is True. |
|
projectId | string¦null | true | The record event project id. | |
timestamp | string(date-time) | true | The record timestamp. | |
userId | string | true | The user id of the record events user. | |
username | string¦null | false | The username of the record events user. Will be empty if includeIdentifyingFields is True. |
AuditLogsRetrieveResponse
{
"count": 0,
"data": [
{
"context": {
"orgId": "string",
"orgName": "string",
"projectName": "string",
"projectType": "string",
"userProjectRole": "string"
},
"event": "string",
"id": "string",
"ip": "string",
"projectId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
count | integer | true | The number of returned items. | |
data | [AuditLogsRetrieveOneResponse] | true | A json array of audit log records structured in the same form as the response GET /api/v2/eventLogs/{recordId}/ | |
next | string(uri)¦null | true | A URL to the next page (if null, no next page exists). | |
previous | string(uri)¦null | true | A URL to the previous page (if null, no previous page exists). | |
totalCount | integer | true | The number of items matching the query condition. |
PredictionUsageObjectResponse
{
"avgExecutionTime": 0,
"blenderModelTypes": "string",
"datasetId": "string",
"deploymentId": "string",
"deploymentType": "string",
"groupId": "string",
"groupName": "string",
"modelId": "string",
"modelType": "string",
"orgId": "string",
"orgName": "string",
"predictionExplanations": true,
"predictionMethod": "string",
"predictionRowCountPerMinute": [
0
],
"predictionRowsCount": 0,
"projectId": "string",
"projectType": "string",
"pythonVersion": "string",
"recommendedModel": true,
"requestCountPerMinute": [
0
],
"requestsCount": 0,
"serverErrorCount": 0,
"timestamp": "2019-08-24T14:15:22Z",
"userErrorCount": 0,
"userId": "string",
"userProjectRole": "string",
"username": "string"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
avgExecutionTime | number | true | The average predictions execution time during timestamp hour |
|
blenderModelTypes | string¦null | false | The type of blender model. | |
datasetId | string | false | The id of the dataset. | |
deploymentId | string¦null | false | The id of the deployment. | |
deploymentType | string¦null | false | The type of deployment | |
groupId | string¦null | false | The id of the group. | |
groupName | string¦null | false | The name of the group. | |
modelId | string¦null | false | The id of the model. | |
modelType | string¦null | false | The type of the model. | |
orgId | string¦null | false | The id of the organization. | |
orgName | string¦null | false | The name of the organization. | |
predictionExplanations | boolean¦null | true | If it contains prediction explanations. | |
predictionMethod | string | true | The prediction method that was used. | |
predictionRowCountPerMinute | [integer]¦null | false | List of row counts per minute. | |
predictionRowsCount | integer | true | Predictions rows count during timestamp hour. |
|
projectId | string¦null | false | The id of the project. | |
projectType | string¦null | false | The type of the project. | |
pythonVersion | string¦null | false | The python version used to build models in the project | |
recommendedModel | boolean¦null | false | If it is a recommended model. | |
requestCountPerMinute | [integer]¦null | false | List of requests per minute. | |
requestsCount | integer | true | Request count during timestamp hour. |
|
serverErrorCount | integer | true | Server error count during timestamp hour. |
|
timestamp | string(date-time) | true | The timestamp of the event. | |
userErrorCount | integer | true | User error count during timestamp hour. |
|
userId | string | true | The id of the user. | |
userProjectRole | string¦null | false | The role of the user to the related project. | |
username | string¦null | false | The username of the user. Will be empty if includeIdentifyingFields is True. |
PredictionUsageRetrieveResponse
{
"count": 0,
"data": [
{
"avgExecutionTime": 0,
"blenderModelTypes": "string",
"datasetId": "string",
"deploymentId": "string",
"deploymentType": "string",
"groupId": "string",
"groupName": "string",
"modelId": "string",
"modelType": "string",
"orgId": "string",
"orgName": "string",
"predictionExplanations": true,
"predictionMethod": "string",
"predictionRowCountPerMinute": [
0
],
"predictionRowsCount": 0,
"projectId": "string",
"projectType": "string",
"pythonVersion": "string",
"recommendedModel": true,
"requestCountPerMinute": [
0
],
"requestsCount": 0,
"serverErrorCount": 0,
"timestamp": "2019-08-24T14:15:22Z",
"userErrorCount": 0,
"userId": "string",
"userProjectRole": "string",
"username": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
count | integer | true | Amount of returned items | |
data | [PredictionUsageObjectResponse] | true | A json array of prediction usage rows described below | |
next | string(uri)¦null | true | A URL to the next page (if null, no next page exists). | |
previous | string(uri)¦null | true | A URL to the previous page (if null, no previous page exists). | |
totalCount | integer | true | Amount of items matching the query condition |
ResourceUsage
{
"currentUsage": 0,
"maxUsage": 0,
"resource": "string",
"timeToExpire": 0
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
currentUsage | integer | true | The usage accumulated within the current window. | |
maxUsage | integer | true | The maximum value currentUsage can take before requests using this resource are denied. | |
resource | string | true | The rate limit resource this usage applies to. | |
timeToExpire | integer | true | The number of seconds until this usage resets to zero. |
ResourceUsageResponse
{
"count": 0,
"next": "string",
"previous": "string",
"usage": [
{
"currentUsage": 0,
"maxUsage": 0,
"resource": "string",
"timeToExpire": 0
}
]
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
count | integer | true | The number of resource usage records. | |
next | string¦null | true | URL pointing to the next page. | |
previous | string¦null | true | URL pointing to the previous page. | |
usage | [ResourceUsage] | true | The resource usage records. |
UsageDataEventsListResponse
{
"data": "ADLS OAuth Failed"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
data | string | true | The available data event options to use in filtering. |
Enumerated Values¶
Property | Value |
---|---|
data | ADLS OAuth Failed |
data | ADLS OAuth Token Obtained |
data | ADLS OAuth Token Renewal Succeeded |
data | ADLS OAuth User Login Started |
data | ADLS OAuth User Login Succeeded |
data | API Key Created |
data | API Key Deleted |
data | API Key Updated |
data | Abort Autopilot |
data | Access request created |
data | Activate account |
data | Activated On First Login |
data | Actuals Uploaded |
data | Add Model |
data | Add New Dataset For Predictions |
data | Add SAML configuration |
data | Advanced Tuning Requested |
data | App Config Changed |
data | Approval Workflow Policy Action |
data | Approval Workflow Policy Created |
data | Approval Workflow Policy Deleted |
data | Approval Workflow Policy Updated |
data | Approve account |
data | Association ID Set |
data | Automated Application Access Revoked from the Group |
data | Automated Application Access Revoked from the Organization |
data | Automated Application Access Revoked from the User |
data | Automated Application Created |
data | Automated Application Deleted |
data | Automated Application Domain Prefix Changed |
data | Automated Application Duplicated |
data | Automated Application Shared |
data | Automated Application Shared with Group |
data | Automated Application Shared with Organization |
data | Automated Application Upgraded |
data | Automated Demo Application Created |
data | Automated Document Created |
data | Automated Document Deleted |
data | Automated Document Downloaded |
data | Automated Document Previewed |
data | Automated Document Requested |
data | Available Forecast Points Computation Job Started |
data | Base Image Built |
data | Batch Prediction Created from Dataset |
data | Batch prediction job aborted |
data | Batch prediction job completed |
data | Batch prediction job created |
data | Batch prediction job failed |
data | Batch prediction job started |
data | Bias And Fairness Cross Class Calculated |
data | Bias And Fairness Insights Calculated |
data | Bias And Fairness Per Class Calculated |
data | Bias and Fairness monitoring settings updated. |
data | Bias and Fairness protected features specified. |
data | Blending Models Limit Exceeded |
data | Bulk Datasets Deleted |
data | Bulk Datasets Tags Appended |
data | CCM Balancer Terminated |
data | CCM CLUSTER Reprovisioned |
data | CCM Cluster Created |
data | CCM Cluster Terminated |
data | CCM Resource Group Created |
data | Calculation of prediction intervals is requested |
data | Challenger Insight Generation Started |
data | Challenger Model Created |
data | Challenger Model Deleted |
data | Challenger Model Promoted |
data | Challenger Models Disabled |
data | Challenger Models Enabled |
data | Change Request Cancelled |
data | Change Request Created |
data | Change Request Reopened |
data | Change Request Resolved |
data | Change Request Review Added |
data | Change Request Updated |
data | Change password |
data | Child Entity Associated With Workspace In AI Catalog |
data | Child Entity Disassociated From Workspace In AI Catalog |
data | Clustering Cluster Names Updated |
data | Comment Created |
data | Comment Deleted |
data | Comment Updated |
data | Completed Feature Discovery Secondary Datasets |
data | Completed Feature Discovery for Primary Dataset |
data | Compliance Doc Deleted |
data | Compliance Doc Downloaded |
data | Compliance Doc Generated |
data | Compliance Doc Previewed |
data | Compute Cluster Added |
data | Compute Cluster Deleted |
data | Compute Cluster Updated |
data | Compute External Insights |
data | Compute Reason Codes |
data | Create account |
data | Created dataset from Data Engine workspace |
data | Created dataset version from Data Engine workspace |
data | Credential Created |
data | Credential Deleted |
data | Credential Updated |
data | Credential Values Retrieved Based On OAuth Configuration ID |
data | Custom Application Access Revoked from the Organization |
data | Custom Application Access Revoked from the User |
data | Custom Application Shared with Group |
data | Custom Application Shared with Organization |
data | Custom Application Shared with User |
data | Custom Metric Bulk Upload Succeeded |
data | Custom Metric Creation Succeeded |
data | Custom Metric Dataset Upload Succeeded |
data | Custom Metric JSON Upload Succeeded |
data | Custom Model Conversion Failed |
data | Custom Model Conversion Files Uploaded |
data | Custom Model Conversion Succeeded |
data | Custom RBAC Access Role Created |
data | Custom RBAC Access Role Deleted |
data | Custom RBAC Access Role Updated |
data | Custom Registered Model Created |
data | Custom Registered Model Version Added |
data | Custom Task Deploy |
data | Custom Task Fit |
data | Custom inference model added |
data | Custom inference model assign training data request received |
data | Custom inference model updated |
data | Custom inference model version assign training data request received |
data | Custom model item added |
data | Custom task added |
data | Custom task updated |
data | Custom task version added |
data | Data Connection Created |
data | Data Connection Deleted |
data | Data Connection Tested |
data | Data Connection Updated |
data | Data Matching ANN Index Profile Built |
data | Data Matching Query Requested |
data | Data Sample Queried For Wrangling |
data | Data Source is created |
data | Data Sources Permadelete Executed |
data | Data Sources Permadelete Failed |
data | Data Sources Permadelete Submitted |
data | Data Store Config Request Submitted |
data | Data Stores Permadelete Executed |
data | Data Stores Permadelete Failed |
data | Data Stores Permadelete Submitted |
data | Data engine query generator created |
data | Data engine query generator deleted |
data | Data engine workspace created |
data | Data engine workspace deleted |
data | Data engine workspace state previewed |
data | Data engine workspace updated |
data | Dataset Categories Modified |
data | Dataset Column Aliases Modified |
data | Dataset Created |
data | Dataset Deleted |
data | Dataset Description Modified |
data | Dataset Download |
data | Dataset Materialized |
data | Dataset Name Modified |
data | Dataset Reloaded |
data | Dataset Shared |
data | Dataset Sharing Removed |
data | Dataset Tags Modified |
data | Dataset Undeleted |
data | Dataset Upload |
data | Dataset Upload is Completed |
data | Dataset Version Deleted |
data | Dataset Version Undeleted |
data | Dataset featurelist created |
data | Dataset featurelist deleted |
data | Dataset featurelist updated |
data | Dataset for predictions with actual value column processed |
data | Dataset refresh job created |
data | Dataset refresh job deleted |
data | Dataset refresh job updated |
data | Dataset relationship created |
data | Dataset relationship updated |
data | Dataset transform created |
data | Datasets Permadelete Executed |
data | Datasets Permadelete Failed |
data | Datasets Permadelete Submitted |
data | Deactivate Account |
data | Decision Flow Created |
data | Decision Flow Model Package Created |
data | Decision Flow Test Downloaded |
data | Decision Flow Version Created |
data | Decision Flow Version Deleted |
data | Default value for Do-Not-Derive is changed |
data | Delete SAML configuration |
data | Deny account |
data | Deploy Model To Hadoop |
data | Deployment Activated |
data | Deployment Actuals Export Created |
data | Deployment Added |
data | Deployment Deactivated |
data | Deployment Deleted |
data | Deployment Humility Rule Added |
data | Deployment Humility Rule Deleted |
data | Deployment Humility Rule Submitted |
data | Deployment Humility Rule Updated |
data | Deployment Humility Setting Updated |
data | Deployment Monitoring Batch Created |
data | Deployment Monitoring Timeliness Setting Changed |
data | Deployment Permanently Erased |
data | Deployment Statistics Reset |
data | Deployment prediction export created |
data | Deployment prediction warning setting updated |
data | Deployment training data export created |
data | Detected Data Quality: Disguised Missing Values |
data | Detected Data Quality: Excess Zero |
data | Detected Data Quality: Imputation Leakage |
data | Detected Data Quality: Inconsistent Gaps |
data | Detected Data Quality: Inliers |
data | Detected Data Quality: Lagged Features |
data | Detected Data Quality: Leading or Trailing Series |
data | Detected Data Quality: Missing Documents |
data | Detected Data Quality: Missing Images |
data | Detected Data Quality: Multicategorical Invalid Format |
data | Detected Data Quality: New Series in Recent Data |
data | Detected Data Quality: Outliers |
data | Detected Data Quality: Quantile Target Sparsity |
data | Detected Data Quality: Quantile Target Zero Inflation |
data | Detected Data Quality: Target Leakage |
data | Detected Data Quality: Target had infrequent negative values |
data | Do-Not-Derive is used |
data | Documentation Request |
data | Download All Charts |
data | Download Chart |
data | Download Codegen |
data | Download Codegen From Deployment |
data | Download Deployment Chart |
data | Download Model |
data | Download Model Package |
data | Download Model Package From Deployment |
data | Download Predictions |
data | Empty Catalog Item Created |
data | Empty Cluster Status Created |
data | Experiment Container Created |
data | Experiment Container Dataset Registered |
data | Experiment Container Dataset Unregistered |
data | Experiment Container Deleted |
data | Experiment Container Entity Linked |
data | Experiment Container Entity Unlinked |
data | Experiment Container Updated |
data | External Predictions Configured |
data | External Registered Model Created |
data | External Registered Model Version Added |
data | FEAR Predict Job Started |
data | Failed Decision Flow Test |
data | Feature Discovery Relationship Quality Assessment Inputs Metrics |
data | Feature Discovery Relationship Quality Assessment Warnings Metrics |
data | Feature Over Geo Computed |
data | Finish Autopilot |
data | First Login After DR Account Migration |
data | General Feedback Submitted |
data | Geometry Over Geo Computed |
data | Geospatial Feature Transform Created |
data | Geospatial Primary Location Column Selected |
data | Global SAML Configuration Added |
data | Global SAML Configuration Deleted |
data | Global SAML Configuration Updated |
data | Group Members Updated |
data | Group created |
data | Group deleted |
data | Group updated |
data | Interaction Feature Created |
data | Interaction Feature Deployment Created |
data | Invitation Accepted |
data | Invitation sent |
data | Job definition created |
data | Job definition updated |
data | Login Fail |
data | Login Succeeded Via Global SAML SSO |
data | Login Success Via SAML SSO |
data | Login Successful |
data | Logout |
data | MLOps Installer Download Request Received |
data | Managed Image Built |
data | Model Deployment Shared |
data | Model Insights Job Submitted |
data | Models Starred |
data | Multi-Factor Auth Disable |
data | Multi-Factor Auth Enable |
data | Multilabel Labelwise ROC With Missing TPR Or FPR Requested |
data | Native Registered Model Created |
data | Native Registered Model Version Added |
data | No predictors are left because of Do-Not-Derive |
data | Non Existent Value Tracker Attachment Removed |
data | Notebook Created |
data | Notebook Deleted |
data | Notebook Environment Variable Deleted |
data | Notebook Environment Variable Edited |
data | Notebook Environment Variables Created |
data | Notebook Environment Variables Deleted |
data | Notebook Metadata Edited |
data | Notebook Revision Created |
data | Notebook Revision Deleted |
data | Notebook Revision Restored |
data | Notebook Schedule Created |
data | Notebook Schedule Deleted |
data | Notebook Session Started |
data | Notebook Session Stopped |
data | Notification channel created |
data | Notification channel deleted |
data | Notification channel updated |
data | Notification policy created |
data | Notification policy deleted |
data | Notification policy updated |
data | Number of bias mitigation jobs on Autopilot stage. |
data | Online Conformal PI Calculation Requested |
data | Organization Perma-Deletion Completed |
data | Organization Perma-Deletion Failed |
data | Organization Perma-Deletion Marked |
data | Organization Perma-Deletion Requested |
data | Organization Perma-Deletion Started |
data | Organization Perma-Deletion Unmarked |
data | Organization created |
data | Organization deleted |
data | Organization updated |
data | Organizations Perma-Deletion Requested |
data | PPS Docker Image Download Request Received |
data | Period accuracy file validation failed |
data | Period accuracy file validation successful |
data | Period accuracy insight computed |
data | Pipeline downsampling build and run started. |
data | Pipeline downsampling run failed to start. |
data | PredictionIntegrationJob Completed |
data | PredictionIntegrationJob Created |
data | PredictionIntegrationJob Deleted |
data | PredictionIntegrationJob Failed |
data | PredictionIntegrationJob Updated |
data | Predictions by Forecast Date Settings Updated |
data | Prime Downloaded |
data | Prime Run |
data | Project Access Revoked from the Group |
data | Project Access Revoked from the Organization |
data | Project Access Revoked from the User |
data | Project Autopilot Configured |
data | Project Cloned |
data | Project Created |
data | Project Created from Dataset |
data | Project Created from Project Export File |
data | Project Created from Wrangled Dataset |
data | Project Deleted |
data | Project Description Updated |
data | Project Exported as Project Export File |
data | Project Options Retrieved |
data | Project Options Updated |
data | Project Permadelete Executed |
data | Project Permadelete Failed |
data | Project Permadelete Submitted |
data | Project Renamed |
data | Project Restored |
data | Project Shared |
data | Project Shared with Group |
data | Project Shared with Organization |
data | Project Target Selected |
data | Published Recipe Data Uploaded |
data | Rate limit user group changed |
data | Recipe Access Revoked from Group |
data | Recipe Access Revoked from Organization |
data | Recipe Access Revoked from User |
data | Recipe Created |
data | Recipe Published |
data | Recipe Shared |
data | Recipe Shared with Group |
data | Recipe Shared with Organization |
data | Registered Model Shared |
data | Registered Model Updated |
data | Registered Model Version Updated |
data | Replaced Model |
data | Request External Insights |
data | Request External Insights - All Datasets |
data | Request Model Insights |
data | Restart Autopilot |
data | Restore Reduced Features |
data | Retraining Policy Cancelled |
data | Retraining Policy Created |
data | Retraining Policy Deleted |
data | Retraining Policy Failed |
data | Retraining Policy Started |
data | Retraining Policy Succeeded |
data | RuleFit Code Downloaded |
data | SHAP Impact Computed |
data | SHAP Matrix Computed |
data | SHAP Predictions Explanations Computed |
data | SHAP Predictions Explanations Preview Computed |
data | SHAP Training Predictions Explanations Computed |
data | Secure Configuration Created |
data | Secure Configuration Deleted |
data | Secure Configuration Shared |
data | Secure Configuration Sharing Removed |
data | Secure Configuration Values Updated |
data | Segment Analysis Enabled |
data | Segment Attributes Specified |
data | Select Model Metric |
data | Start Autopilot |
data | Successful Decision Flow Test |
data | Successful Login using OIDC flow |
data | Successful Login using OIDC token exchange |
data | Successful Login via Google Idp |
data | Target is set as Do-Not-Derive |
data | Text prediction explanations computed |
data | Train Model |
data | Unsupervised Mode Started |
data | Update SAML configuration |
data | Update account |
data | User Agreement Accepted |
data | User Agreement Declined |
data | User Append Columns Download With Predictions |
data | User Blueprint Added To Repository |
data | User Blueprint Created |
data | User Blueprint Deleted |
data | User Blueprint Deleted In Bulk |
data | User Blueprint Description Modified |
data | User Blueprint Name Modified |
data | User Blueprint Retrieved |
data | User Blueprint Tags Modified |
data | User Blueprint Tasks Retrieved |
data | User Blueprint Updated |
data | User Blueprint Validated |
data | User Blueprints Listed |
data | User Provisioned From JWT |
data | Users Perma-Deletion Canceled |
data | Users Perma-Deletion Canceling |
data | Users Perma-Deletion Completed |
data | Users Perma-Deletion Failed |
data | Users Perma-Deletion Preview Building Canceled |
data | Users Perma-Deletion Preview Building Canceling |
data | Users Perma-Deletion Preview Building Completed |
data | Users Perma-Deletion Preview Building Failed |
data | Users Perma-Deletion Preview Building Started |
data | Users Perma-Deletion Preview Building Submitted |
data | Users Perma-Deletion Started |
data | Users Perma-Deletion Submitted |
data | Value Tracker Attachment Added |
data | Value Tracker Attachment Removed |
data | Value Tracker Created |
data | Value Tracker Stage Changed |
data | Value Tracker Updated |
data | Workspace Description Modified |
data | Workspace Marked As Deleted In AI Catalog |
data | Workspace Modified |
data | Workspace Name Modified |
data | Workspace Registered In AI Catalog |
data | Workspace Scheduled Batch Run Failed |
data | Workspace Scheduled Batch Run Started |
data | Workspace Scheduled Batch Run Succeeded |
data | Workspace Tags Modified |
data | Workspace scheduled batch processing job created |
data | Workspace scheduled batch processing job deleted |
data | Workspace scheduled batch processing job updated |
data | aiAPI Portal Login |
UsageDataExport
{
"end": "2019-08-24T14:15:22Z",
"include": [
"string"
],
"includeIdentifyingFields": true,
"includeReport": [
"ADMIN_USAGE"
],
"noCache": true,
"projectId": "string",
"start": "2019-08-24T14:15:22Z",
"userId": "string"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
end | string(date-time)¦null | false | The upper bound of stored events timestamp to include within the artifact. | |
include | [string] | false | Additional fields to be included. | |
includeIdentifyingFields | boolean | true | Indicates if identifying information like user names, project names, etc. should be included or not. Defaults to True. | |
includeReport | [string]¦null | false | The list of reports that should be generated. Will default to None if not specified. |
|
noCache | boolean | false | Switches off caching. | |
projectId | string | false | Only actions that are connected with the project will be retrieved. | |
start | string(date-time)¦null | false | The lower bound of stored events timestamp to include within the artifact. | |
userId | string | false | Only actions performed by this user will be retrieved. |
UsageDataRetrieveResponse
{
"data": "string"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
data | string(binary) | true | The requested usage artifact in .zip format. |