Run Monitors for Artifacts

post

https://gateway.revefi.com/api/v1/monitor/run

Trigger runs for monitors associated with the specified artifacts in Revefi

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body specifying artifacts and optional monitor IDs to run

dataSourceId

int64

required

Data Source Id of the Revefi connection. Can be obtained by going to Revefi (app.revefi.com) and looking for dsId in the URL

artifacts

array of objects

required

length between 1 and 10

List of tables to run monitors for. Maximum of 10 artifacts.

artifacts*

databaseName

string

required

Name of the database for the table on which data quality monitor needs to be added

schemaName

string

required

Name of the schema for the table on which data quality monitor needs to be added

tableName

string

required

Name of the table on which data quality monitor needs to be added

monitorIds

array of int64s

Optional list of monitor IDs to run. If not provided, all monitors for the given artifacts will be run.

monitorIds

backfill

boolean

Defaults to false

Optional flag to backfill historical data

dryRun

boolean

Defaults to false

Optional flag to run monitors in dry-run mode without persisting results

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200

Successful operation

400

Validation exception

401

Invalid API access token

403

Insufficient permissions for the API call

404

Artifact not found in Revefi

429

Number of requests sent exceed the rate limit

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here!