Skip to content

Click in-app to access the full platform documentation for your version of DataRobot.

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.111.38/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 Project Permadelete Failed
event Automated Demo Application Created
event Compute External Insights
event Dataset refresh job created
event User Blueprint Created
event Batch prediction job failed
event Bulk Datasets Deleted
event Users Perma-Deletion Failed
event Multilabel Labelwise ROC With Missing TPR Or FPR Requested
event Login Succeeded Via Global SAML SSO
event ADLS OAuth Token Obtained
event User Blueprint Added To Repository
event Automated Application Access Revoked from the Group
event Automated Document Requested
event Request External Insights
event Compute Cluster Added
event User Blueprint Name Modified
event Bulk Datasets Tags Appended
event Deactivate Account
event Job definition updated
event PredictionIntegrationJob Deleted
event Custom Task Prediction Made
event Group deleted
event Experiment Container Updated
event CCM Resource Group Created
event Experiment Container References Fetched
event Approval Workflow Policy Updated
event Models Starred
event Custom Metric JSON Upload Succeeded
event Challenger Model Deleted
event Empty Catalog Item Created
event Detected Data Quality: Target had infrequent negative values
event Users Perma-Deletion Preview Building Started
event Dataset transform created
event Number of bias mitigation jobs on Autopilot stage.
event Dataset for predictions with actual value column processed
event Automated Application Domain Prefix Changed
event Group created
event Compute Cluster Updated
event Retraining Policy Created
event Experiment Container Entity Unlinked
event Users Perma-Deletion Preview Building Submitted
event Dataset refresh job deleted
event Restart Autopilot
event Decision Flow Version Deleted
event Data engine query generator created
event Job definition created
event Activate account
event aiAPI Portal Login
event Dataset Version Undeleted
event Organization updated
event Group Members Updated
event Recipe Shared
event Model Deployment Shared
event Automated Application Upgraded
event Organizations Perma-Deletion Requested
event Project Access Revoked from the Organization
event SHAP Predictions Explanations Preview Computed
event Managed Image Built
event Detected Data Quality: New Series in Recent Data
event CCM Balancer Terminated
event Approval Workflow Policy Deleted
event Segment Analysis Enabled
event User Blueprint Tasks Retrieved
event Compliance Doc Deleted
event Users Perma-Deletion Preview Building Canceled
event Deployment Permanently Erased
event Experiment Container Entity Linked
event Detected Data Quality: Excess Zero
event Association ID Set
event Detected Data Quality: Outliers
event Online Conformal PI Calculation Requested
event Feature Discovery Relationship Quality Assessment Inputs Metrics
event Project Description Updated
event Automated Document Created
event Delete SAML configuration
event Child Entity Disassociated From Workspace In AI Catalog
event Successful Login via Google Idp
event User Blueprint Tags Modified
event Completed Feature Discovery for Primary Dataset
event Interaction Feature Deployment Created
event Automated Document Previewed
event Workspace Scheduled Batch Run Failed
event Project Renamed
event Data Store Config Request Submitted
event Detected Data Quality: Multicategorical Invalid Format
event Created dataset from Data Engine workspace
event Retraining Policy Cancelled
event Logout
event Failed Decision Flow Test
event Pipeline downsampling build and run started.
event Finish Autopilot
event Add Model
event API Key Updated
event Organization Perma-Deletion Failed
event Geometry Over Geo Computed
event Workspace Name Modified
event Value Tracker Updated
event Dataset Description Modified
event Add SAML configuration
event Project Target Selected
event Data Source is created
event Global SAML Configuration Deleted
event Detected Data Quality: Target Leakage
event Automated Application Shared
event Data Sources Permadelete Failed
event Period accuracy insight computed
event Data Connection Created
event Change Request Updated
event Notification policy updated
event Base Image Built
event Multi-Factor Auth Disable
event Organization Perma-Deletion Marked
event Custom Model Conversion Failed
event Detected Data Quality: Disguised Missing Values
event Geospatial Feature Transform Created
event Project Created
event Approval Workflow Policy Created
event Update account
event Experiment Container Created
event Automated Application Shared with Group
event Project Options Updated
event Datasets Permadelete Submitted
event Prime Downloaded
event Workspace Scheduled Batch Run Succeeded
event Custom inference model updated
event Custom RBAC Access Role Created
event Created dataset version from Data Engine workspace
event Workspace scheduled batch processing job deleted
event Users Perma-Deletion Preview Building Canceling
event Successful Login using OIDC flow
event Login Fail
event Value Tracker Created
event Batch Prediction Created from Dataset
event Decision Flow Version Created
event Text prediction explanations computed
event Retraining Policy Failed
event CCM Cluster Terminated
event Data engine workspace state previewed
event Experiment Container Entities Fetched
event Abort Autopilot
event Organization Perma-Deletion Completed
event User Blueprint Deleted
event Download Model Package From Deployment
event MLOps Installer Download Request Received
event Comment Updated
event Workspace scheduled batch processing job created
event No predictors are left because of Do-Not-Derive
event External Predictions Configured
event Datasets Permadelete Failed
event Dataset featurelist deleted
event Project Shared
event Access request created
event Documentation Request
event Do-Not-Derive is used
event Data Connection Deleted
event Dataset featurelist updated
event Compliance Doc Generated
event Deployment Humility Rule Updated
event Workspace scheduled batch processing job updated
event Segment Analysis Used
event Detected Data Quality: Quantile Target Sparsity
event Interaction Feature Created
event Dataset Upload is Completed
event Project Created from Project Export File
event Reset API Token For User
event Custom Model Conversion Files Uploaded
event Deny account
event First Login After DR Account Migration
event Comment Created
event Deployment Humility Setting Updated
event Restore Reduced Features
event Experiment Container Deleted
event Custom Metric Dataset Upload Succeeded
event API Key Created
event Organization created
event SHAP Matrix Computed
event Deployment Deleted
event Automated Application Created
event Dataset Column Aliases Modified
event Project Exported as Project Export File
event Bias And Fairness Insights Calculated
event Dataset Undeleted
event CCM Cluster Created
event Detected Data Quality: Leading or Trailing Series
event Model Insights Job Submitted
event User Blueprints Listed
event Data Connection Updated
event Automated Application Duplicated
event Data Stores Permadelete Failed
event Unsupervised Mode Started
event Select Model Metric
event Actuals Uploaded
event Blending Models Limit Exceeded
event Dataset Tags Modified
event Dataset Upload
event Start Autopilot
event Credential Created
event SHAP Impact Computed
event Data Sources Permadelete Executed
event Invitation Accepted
event Detected Data Quality: Inconsistent Gaps
event Custom Task Fit
event Create account
event Group updated
event Compliance Doc Previewed
event Workspace Registered In AI Catalog
event Clustering Cluster Names Updated
event ADLS OAuth User Login Succeeded
event Dataset refresh job updated
event Project Options Retrieved
event Deployment Statistics Reset
event Download Model Package
event Dataset Version Deleted
event Project Permadelete Submitted
event Change Request Cancelled
event Data engine workspace deleted
event Bias and Fairness protected features specified.
event Download Model
event Automated Application Access Revoked from the Organization
event Workspace Scheduled Batch Run Started
event Train Model
event Automated Document Deleted
event RuleFit Code Downloaded
event PredictionIntegrationJob Completed
event Detected Data Quality: Missing Images
event Approval Workflow Policy Action
event Prime Run
event User Agreement Declined
event PredictionIntegrationJob Updated
event Value Tracker Stage Changed
event Automated Application Shared with Organization
event Predictions by Forecast Date Settings Updated
event Decision Flow Created
event Successful Login using OIDC token exchange
event Change Request Created
event Download Chart
event Challenger Insight Generation Started
event Deployment Added
event Dataset relationship created
event Compliance Doc Downloaded
event Value Tracker Attachment Added
event Successful Decision Flow Test
event User Blueprint Updated
event Login Success Via SAML SSO
event Recipe Access Revoked from User
event Custom RBAC Access Role Updated
event Add New Dataset For Predictions
event Advanced Tuning Requested
event Users Perma-Deletion Started
event Update SAML configuration
event Challenger Model Created
event Deployment training data export created
event Global SAML Configuration Updated
event Download Codegen
event Users Perma-Deletion Canceled
event Download Predictions
event Compute Cluster Deleted
event Data Sources Permadelete Submitted
event ADLS OAuth Token Renewal Succeeded
event Credential Deleted
event User Append Columns Download With Predictions
event General Feedback Submitted
event Batch prediction job started
event Organization deleted
event Bias And Fairness Per Class Calculated
event Notification channel updated
event Request Model Insights
event Approve account
event Global SAML Configuration Added
event Project Cloned
event Data Stores Permadelete Submitted
event Available Forecast Points Computation Job Started
event Data engine workspace created
event Workspace Marked As Deleted In AI Catalog
event Custom Model Conversion Succeeded
event Recipe Shared with Group
event Deployment Humility Rule Deleted
event Data Stores Permadelete Executed
event Activated On First Login
event App Config Changed
event Blueprint Search Executed
event Dataset Download
event Rate limit user group changed
event Calculation of prediction intervals is requested
event Project Shared with Organization
event User Blueprint Deleted In Bulk
event ADLS OAuth User Login Started
event Feature Over Geo Computed
event Users Perma-Deletion Submitted
event Deployment prediction export created
event Automated Application Access Revoked from the User
event Replaced Model
event Child Entity Associated With Workspace In AI Catalog
event Period accuracy file validation failed
event Segment Attributes Specified
event PredictionIntegrationJob Created
event Detected Data Quality: Imputation Leakage
event Workspace Tags Modified
event Geospatial Primary Location Column Selected
event SHAP Training Predictions Explanations Computed
event ADLS OAuth Failed
event Dataset Categories Modified
event Dataset Created
event Dataset Sharing Removed
event Deployment Humility Rule Submitted
event Recipe Access Revoked from Organization
event Dataset Materialized
event Recipe Shared with Organization
event Data engine workspace updated
event Custom Task Deploy
event User Blueprint Description Modified
event Batch prediction job completed
event Notification channel created
event Login Successful
event Project Access Revoked from the User
event Detected Data Quality: Inliers
event Deploy Model To Hadoop
event Completed Feature Discovery Secondary Datasets
event Pipeline downsampling run failed to start.
event Detected Data Quality: Missing Documents
event Empty Cluster Status Created
event Users Perma-Deletion Completed
event Workspace Modified
event Users Perma-Deletion Canceling
event Change password
event Project Permadelete Executed
event Dataset featurelist created
event Download All Charts
event Project Shared with Group
event Notification channel deleted
event Download Codegen From Deployment
event Project Deleted
event Comment Deleted
event Custom task updated
event Notification policy created
event Compute Reason Codes
event Detected Data Quality: Quantile Target Zero Inflation
event Dataset Reloaded
event Dataset Deleted
event API Key Deleted
event Custom model item added
event Default value for Do-Not-Derive is changed
event Automated Application Deleted
event Experiment Containers Listed
event Batch prediction job created
event Change Request Reopened
event Users Perma-Deletion Preview Building Failed
event Deployment Activated
event Invitation sent
event Notification policy deleted
event Credential Updated
event Target is set as Do-Not-Derive
event Organization Perma-Deletion Requested
event Datasets Permadelete Executed
event Change Request Review Added
event Automated Document Downloaded
event Bias And Fairness Cross Class Calculated
event Multi-Factor Auth Enable
event Challenger Model Promoted
event Data Connection Tested
event Value Tracker Attachment Removed
event Project Autopilot Configured
event Users Perma-Deletion Preview Building Completed
event Non Existent Value Tracker Attachment Removed
event SHAP Predictions Explanations Computed
event Dataset Shared
event Custom task version added
event Download Deployment Chart
event Project Created from Dataset
event User Blueprint Retrieved
event Detected Data Quality: Lagged Features
event Experiment Container Fetched
event Deployment Deactivated
event Feature Discovery Relationship Quality Assessment Warnings Metrics
event Challenger Models Enabled
event Workspace Description Modified
event User Blueprint Validated
event PPS Docker Image Download Request Received
event Organization Perma-Deletion Unmarked
event Challenger Models Disabled
event Retraining Policy Succeeded
event FEAR Predict Job Started
event Custom inference model added
event CCM CLUSTER Reprovisioned
event Custom RBAC Access Role Deleted
event Project Restored
event Recipe Access Revoked from Group
event Deployment prediction warning setting updated
event Decision Flow Model Package Created
event Deployment Humility Rule Added
event User Provisioned From JWT
event PredictionIntegrationJob Failed
event User Agreement Accepted
event Dataset Name Modified
event Dataset relationship updated
event Organization Perma-Deletion Started
event Bias and Fairness monitoring settings updated.
event Decision Flow Test Downloaded
event Retraining Policy Deleted
event Batch prediction job aborted
event Project Access Revoked from the Group
event Period accuracy file validation successful
event Custom task added
event Retraining Policy Started
event Change Request Resolved
event Data engine query generator deleted
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.111.38/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.111.38/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.111.38/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.111.38/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": [
    "SYSTEM_INFO"
  ],
  "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.111.38/api/v2/usageDataExports/supportedEvents/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

{
  "data": "Project Permadelete 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.111.38/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.111.38/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.111.38/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.111.38/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 none The id of the organization.
orgName string¦null false none The name of the organization.
projectName string¦null false none The name of the project.
projectType string¦null false none The type of project.
userProjectRole string¦null false none The role of the user associated with this project.

AuditLogsEventListResponse

{
  "count": 0,
  "data": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
count integer true none Total count of event labels.
data [string] true none 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 none An object with additional attributes for the record.
event string true none The record event label, e.g. 'Start Autopilot'.
id string true none The record ID.
ip string¦null false none The IP address of the server where the record event happened. Will be empty if includeIdentifyingFields is True.
projectId string¦null true none The record event project id.
timestamp string(date-time) true none The record timestamp.
userId string true none The user id of the record events user.
username string¦null false none 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 none The number of returned items.
data [AuditLogsRetrieveOneResponse] true none 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 none A URL to the next page (if null, no next page exists).
previous string(uri)¦null true none A URL to the previous page (if null, no previous page exists).
totalCount integer true none 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 none The average predictions execution time during timestamp hour
blenderModelTypes string¦null false none The type of blender model.
datasetId string false none The id of the dataset.
deploymentId string¦null false none The id of the deployment.
deploymentType string¦null false none The type of deployment
groupId string¦null false none The id of the group.
groupName string¦null false none The name of the group.
modelId string¦null false none The id of the model.
modelType string¦null false none The type of the model.
orgId string¦null false none The id of the organization.
orgName string¦null false none The name of the organization.
predictionExplanations boolean¦null true none If it contains prediction explanations.
predictionMethod string true none The prediction method that was used.
predictionRowCountPerMinute [integer]¦null false none List of row counts per minute.
predictionRowsCount integer true none Predictions rows count during timestamp hour.
projectId string¦null false none The id of the project.
projectType string¦null false none The type of the project.
pythonVersion string¦null false none The python version used to build models in the project
recommendedModel boolean¦null false none If it is a recommended model.
requestCountPerMinute [integer]¦null false none List of requests per minute.
requestsCount integer true none Request count during timestamp hour.
serverErrorCount integer true none Server error count during timestamp hour.
timestamp string(date-time) true none The timestamp of the event.
userErrorCount integer true none User error count during timestamp hour.
userId string true none The id of the user.
userProjectRole string¦null false none The role of the user to the related project.
username string¦null false none 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 none Amount of returned items
data [PredictionUsageObjectResponse] true none A json array of prediction usage rows described below
next string(uri)¦null true none A URL to the next page (if null, no next page exists).
previous string(uri)¦null true none A URL to the previous page (if null, no previous page exists).
totalCount integer true none 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 none The usage accumulated within the current window.
maxUsage integer true none The maximum value currentUsage can take before requests using this resource are denied.
resource string true none The rate limit resource this usage applies to.
timeToExpire integer true none 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 none The number of resource usage records.
next string¦null true none URL pointing to the next page.
previous string¦null true none URL pointing to the previous page.
usage [ResourceUsage] true none The resource usage records.

UsageDataEventsListResponse

{
  "data": "Project Permadelete Failed"
}

Properties

Name Type Required Restrictions Description
data string true none The available data event options to use in filtering.

Enumerated Values

Property Value
data Project Permadelete Failed
data Automated Demo Application Created
data Compute External Insights
data Dataset refresh job created
data User Blueprint Created
data Batch prediction job failed
data Bulk Datasets Deleted
data Users Perma-Deletion Failed
data Multilabel Labelwise ROC With Missing TPR Or FPR Requested
data Login Succeeded Via Global SAML SSO
data ADLS OAuth Token Obtained
data User Blueprint Added To Repository
data Automated Application Access Revoked from the Group
data Automated Document Requested
data Request External Insights
data Compute Cluster Added
data User Blueprint Name Modified
data Bulk Datasets Tags Appended
data Deactivate Account
data Job definition updated
data PredictionIntegrationJob Deleted
data Custom Task Prediction Made
data Group deleted
data Experiment Container Updated
data CCM Resource Group Created
data Experiment Container References Fetched
data Approval Workflow Policy Updated
data Models Starred
data Custom Metric JSON Upload Succeeded
data Challenger Model Deleted
data Empty Catalog Item Created
data Detected Data Quality: Target had infrequent negative values
data Users Perma-Deletion Preview Building Started
data Dataset transform created
data Number of bias mitigation jobs on Autopilot stage.
data Dataset for predictions with actual value column processed
data Automated Application Domain Prefix Changed
data Group created
data Compute Cluster Updated
data Retraining Policy Created
data Experiment Container Entity Unlinked
data Users Perma-Deletion Preview Building Submitted
data Dataset refresh job deleted
data Restart Autopilot
data Decision Flow Version Deleted
data Data engine query generator created
data Job definition created
data Activate account
data aiAPI Portal Login
data Dataset Version Undeleted
data Organization updated
data Group Members Updated
data Recipe Shared
data Model Deployment Shared
data Automated Application Upgraded
data Organizations Perma-Deletion Requested
data Project Access Revoked from the Organization
data SHAP Predictions Explanations Preview Computed
data Managed Image Built
data Detected Data Quality: New Series in Recent Data
data CCM Balancer Terminated
data Approval Workflow Policy Deleted
data Segment Analysis Enabled
data User Blueprint Tasks Retrieved
data Compliance Doc Deleted
data Users Perma-Deletion Preview Building Canceled
data Deployment Permanently Erased
data Experiment Container Entity Linked
data Detected Data Quality: Excess Zero
data Association ID Set
data Detected Data Quality: Outliers
data Online Conformal PI Calculation Requested
data Feature Discovery Relationship Quality Assessment Inputs Metrics
data Project Description Updated
data Automated Document Created
data Delete SAML configuration
data Child Entity Disassociated From Workspace In AI Catalog
data Successful Login via Google Idp
data User Blueprint Tags Modified
data Completed Feature Discovery for Primary Dataset
data Interaction Feature Deployment Created
data Automated Document Previewed
data Workspace Scheduled Batch Run Failed
data Project Renamed
data Data Store Config Request Submitted
data Detected Data Quality: Multicategorical Invalid Format
data Created dataset from Data Engine workspace
data Retraining Policy Cancelled
data Logout
data Failed Decision Flow Test
data Pipeline downsampling build and run started.
data Finish Autopilot
data Add Model
data API Key Updated
data Organization Perma-Deletion Failed
data Geometry Over Geo Computed
data Workspace Name Modified
data Value Tracker Updated
data Dataset Description Modified
data Add SAML configuration
data Project Target Selected
data Data Source is created
data Global SAML Configuration Deleted
data Detected Data Quality: Target Leakage
data Automated Application Shared
data Data Sources Permadelete Failed
data Period accuracy insight computed
data Data Connection Created
data Change Request Updated
data Notification policy updated
data Base Image Built
data Multi-Factor Auth Disable
data Organization Perma-Deletion Marked
data Custom Model Conversion Failed
data Detected Data Quality: Disguised Missing Values
data Geospatial Feature Transform Created
data Project Created
data Approval Workflow Policy Created
data Update account
data Experiment Container Created
data Automated Application Shared with Group
data Project Options Updated
data Datasets Permadelete Submitted
data Prime Downloaded
data Workspace Scheduled Batch Run Succeeded
data Custom inference model updated
data Custom RBAC Access Role Created
data Created dataset version from Data Engine workspace
data Workspace scheduled batch processing job deleted
data Users Perma-Deletion Preview Building Canceling
data Successful Login using OIDC flow
data Login Fail
data Value Tracker Created
data Batch Prediction Created from Dataset
data Decision Flow Version Created
data Text prediction explanations computed
data Retraining Policy Failed
data CCM Cluster Terminated
data Data engine workspace state previewed
data Experiment Container Entities Fetched
data Abort Autopilot
data Organization Perma-Deletion Completed
data User Blueprint Deleted
data Download Model Package From Deployment
data MLOps Installer Download Request Received
data Comment Updated
data Workspace scheduled batch processing job created
data No predictors are left because of Do-Not-Derive
data External Predictions Configured
data Datasets Permadelete Failed
data Dataset featurelist deleted
data Project Shared
data Access request created
data Documentation Request
data Do-Not-Derive is used
data Data Connection Deleted
data Dataset featurelist updated
data Compliance Doc Generated
data Deployment Humility Rule Updated
data Workspace scheduled batch processing job updated
data Segment Analysis Used
data Detected Data Quality: Quantile Target Sparsity
data Interaction Feature Created
data Dataset Upload is Completed
data Project Created from Project Export File
data Reset API Token For User
data Custom Model Conversion Files Uploaded
data Deny account
data First Login After DR Account Migration
data Comment Created
data Deployment Humility Setting Updated
data Restore Reduced Features
data Experiment Container Deleted
data Custom Metric Dataset Upload Succeeded
data API Key Created
data Organization created
data SHAP Matrix Computed
data Deployment Deleted
data Automated Application Created
data Dataset Column Aliases Modified
data Project Exported as Project Export File
data Bias And Fairness Insights Calculated
data Dataset Undeleted
data CCM Cluster Created
data Detected Data Quality: Leading or Trailing Series
data Model Insights Job Submitted
data User Blueprints Listed
data Data Connection Updated
data Automated Application Duplicated
data Data Stores Permadelete Failed
data Unsupervised Mode Started
data Select Model Metric
data Actuals Uploaded
data Blending Models Limit Exceeded
data Dataset Tags Modified
data Dataset Upload
data Start Autopilot
data Credential Created
data SHAP Impact Computed
data Data Sources Permadelete Executed
data Invitation Accepted
data Detected Data Quality: Inconsistent Gaps
data Custom Task Fit
data Create account
data Group updated
data Compliance Doc Previewed
data Workspace Registered In AI Catalog
data Clustering Cluster Names Updated
data ADLS OAuth User Login Succeeded
data Dataset refresh job updated
data Project Options Retrieved
data Deployment Statistics Reset
data Download Model Package
data Dataset Version Deleted
data Project Permadelete Submitted
data Change Request Cancelled
data Data engine workspace deleted
data Bias and Fairness protected features specified.
data Download Model
data Automated Application Access Revoked from the Organization
data Workspace Scheduled Batch Run Started
data Train Model
data Automated Document Deleted
data RuleFit Code Downloaded
data PredictionIntegrationJob Completed
data Detected Data Quality: Missing Images
data Approval Workflow Policy Action
data Prime Run
data User Agreement Declined
data PredictionIntegrationJob Updated
data Value Tracker Stage Changed
data Automated Application Shared with Organization
data Predictions by Forecast Date Settings Updated
data Decision Flow Created
data Successful Login using OIDC token exchange
data Change Request Created
data Download Chart
data Challenger Insight Generation Started
data Deployment Added
data Dataset relationship created
data Compliance Doc Downloaded
data Value Tracker Attachment Added
data Successful Decision Flow Test
data User Blueprint Updated
data Login Success Via SAML SSO
data Recipe Access Revoked from User
data Custom RBAC Access Role Updated
data Add New Dataset For Predictions
data Advanced Tuning Requested
data Users Perma-Deletion Started
data Update SAML configuration
data Challenger Model Created
data Deployment training data export created
data Global SAML Configuration Updated
data Download Codegen
data Users Perma-Deletion Canceled
data Download Predictions
data Compute Cluster Deleted
data Data Sources Permadelete Submitted
data ADLS OAuth Token Renewal Succeeded
data Credential Deleted
data User Append Columns Download With Predictions
data General Feedback Submitted
data Batch prediction job started
data Organization deleted
data Bias And Fairness Per Class Calculated
data Notification channel updated
data Request Model Insights
data Approve account
data Global SAML Configuration Added
data Project Cloned
data Data Stores Permadelete Submitted
data Available Forecast Points Computation Job Started
data Data engine workspace created
data Workspace Marked As Deleted In AI Catalog
data Custom Model Conversion Succeeded
data Recipe Shared with Group
data Deployment Humility Rule Deleted
data Data Stores Permadelete Executed
data Activated On First Login
data App Config Changed
data Blueprint Search Executed
data Dataset Download
data Rate limit user group changed
data Calculation of prediction intervals is requested
data Project Shared with Organization
data User Blueprint Deleted In Bulk
data ADLS OAuth User Login Started
data Feature Over Geo Computed
data Users Perma-Deletion Submitted
data Deployment prediction export created
data Automated Application Access Revoked from the User
data Replaced Model
data Child Entity Associated With Workspace In AI Catalog
data Period accuracy file validation failed
data Segment Attributes Specified
data PredictionIntegrationJob Created
data Detected Data Quality: Imputation Leakage
data Workspace Tags Modified
data Geospatial Primary Location Column Selected
data SHAP Training Predictions Explanations Computed
data ADLS OAuth Failed
data Dataset Categories Modified
data Dataset Created
data Dataset Sharing Removed
data Deployment Humility Rule Submitted
data Recipe Access Revoked from Organization
data Dataset Materialized
data Recipe Shared with Organization
data Data engine workspace updated
data Custom Task Deploy
data User Blueprint Description Modified
data Batch prediction job completed
data Notification channel created
data Login Successful
data Project Access Revoked from the User
data Detected Data Quality: Inliers
data Deploy Model To Hadoop
data Completed Feature Discovery Secondary Datasets
data Pipeline downsampling run failed to start.
data Detected Data Quality: Missing Documents
data Empty Cluster Status Created
data Users Perma-Deletion Completed
data Workspace Modified
data Users Perma-Deletion Canceling
data Change password
data Project Permadelete Executed
data Dataset featurelist created
data Download All Charts
data Project Shared with Group
data Notification channel deleted
data Download Codegen From Deployment
data Project Deleted
data Comment Deleted
data Custom task updated
data Notification policy created
data Compute Reason Codes
data Detected Data Quality: Quantile Target Zero Inflation
data Dataset Reloaded
data Dataset Deleted
data API Key Deleted
data Custom model item added
data Default value for Do-Not-Derive is changed
data Automated Application Deleted
data Experiment Containers Listed
data Batch prediction job created
data Change Request Reopened
data Users Perma-Deletion Preview Building Failed
data Deployment Activated
data Invitation sent
data Notification policy deleted
data Credential Updated
data Target is set as Do-Not-Derive
data Organization Perma-Deletion Requested
data Datasets Permadelete Executed
data Change Request Review Added
data Automated Document Downloaded
data Bias And Fairness Cross Class Calculated
data Multi-Factor Auth Enable
data Challenger Model Promoted
data Data Connection Tested
data Value Tracker Attachment Removed
data Project Autopilot Configured
data Users Perma-Deletion Preview Building Completed
data Non Existent Value Tracker Attachment Removed
data SHAP Predictions Explanations Computed
data Dataset Shared
data Custom task version added
data Download Deployment Chart
data Project Created from Dataset
data User Blueprint Retrieved
data Detected Data Quality: Lagged Features
data Experiment Container Fetched
data Deployment Deactivated
data Feature Discovery Relationship Quality Assessment Warnings Metrics
data Challenger Models Enabled
data Workspace Description Modified
data User Blueprint Validated
data PPS Docker Image Download Request Received
data Organization Perma-Deletion Unmarked
data Challenger Models Disabled
data Retraining Policy Succeeded
data FEAR Predict Job Started
data Custom inference model added
data CCM CLUSTER Reprovisioned
data Custom RBAC Access Role Deleted
data Project Restored
data Recipe Access Revoked from Group
data Deployment prediction warning setting updated
data Decision Flow Model Package Created
data Deployment Humility Rule Added
data User Provisioned From JWT
data PredictionIntegrationJob Failed
data User Agreement Accepted
data Dataset Name Modified
data Dataset relationship updated
data Organization Perma-Deletion Started
data Bias and Fairness monitoring settings updated.
data Decision Flow Test Downloaded
data Retraining Policy Deleted
data Batch prediction job aborted
data Project Access Revoked from the Group
data Period accuracy file validation successful
data Custom task added
data Retraining Policy Started
data Change Request Resolved
data Data engine query generator deleted

UsageDataExport

{
  "end": "2019-08-24T14:15:22Z",
  "include": [
    "string"
  ],
  "includeIdentifyingFields": true,
  "includeReport": [
    "SYSTEM_INFO"
  ],
  "noCache": true,
  "projectId": "string",
  "start": "2019-08-24T14:15:22Z",
  "userId": "string"
}

Properties

Name Type Required Restrictions Description
end string(date-time)¦null false none The upper bound of stored events timestamp to include within the artifact.
include [string] false none Additional fields to be included.
includeIdentifyingFields boolean true none Indicates if identifying information like user names, project names, etc. should be included or not. Defaults to True.
includeReport [string]¦null false none The list of reports that should be generated. Will default to None if not specified.
noCache boolean false none Switches off caching.
projectId string false none Only actions that are connected with the project will be retrieved.
start string(date-time)¦null false none The lower bound of stored events timestamp to include within the artifact.
userId string false none Only actions performed by this user will be retrieved.

UsageDataRetrieveResponse

{
  "data": "string"
}

Properties

Name Type Required Restrictions Description
data string(binary) true none The requested usage artifact in .zip format.

Updated December 7, 2022
Back to top