RunReveal

CustomViewsCreate creates a new custom view over workspace logs or external storage.

CustomViewsCreate creates a new custom view over workspace logs or external storage.

POST
/custom-views/create

Request Body

application/jsonRequired

columnsarray<object>

descriptionstring

externalStorageobject

externalStorageSecretsobject

kindstring

namestring

sourceIdstring

sourceTypestring

curl -X POST "https://api.runreveal.com/custom-views/create" \
  -H "Content-Type: application/json" \
  -d '{
    "columns": [
      {
        "description": "string",
        "name": "string",
        "sql": "string",
        "type": "string"
      }
    ],
    "description": "string",
    "externalStorage": {
      "authMode": "string",
      "bucket": "string",
      "compression": "string",
      "endpoint": "string",
      "format": "string",
      "partitionColumns": [
        "string"
      ],
      "pathGlob": "string",
      "prefix": "string",
      "provider": "string",
      "region": "string",
      "useHivePartitioning": true
    },
    "externalStorageSecrets": {
      "accessKeyId": "string",
      "roleArn": "string",
      "secretAccessKey": "string",
      "sessionToken": "string"
    },
    "kind": "string",
    "name": "string",
    "sourceId": "string",
    "sourceType": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "columns": [
      {
        "description": "string",
        "name": "string",
        "sql": "string",
        "type": "string"
      }
    ],
    "createdAt": {},
    "description": "string",
    "externalStorage": {
      "authMode": "string",
      "bucket": "string",
      "compression": "string",
      "endpoint": "string",
      "format": "string",
      "partitionColumns": [
        "string"
      ],
      "pathGlob": "string",
      "prefix": "string",
      "provider": "string",
      "region": "string",
      "useHivePartitioning": true
    },
    "id": "string",
    "kind": "string",
    "lastSyncError": "string",
    "lastSyncedAt": {},
    "name": "string",
    "sourceId": "string",
    "sourceType": "string",
    "syncStatus": "string",
    "updatedAt": {},
    "workspaceId": "string"
  },
  "success": true
}

CustomViewsDelete deletes a custom view

CustomViewsDelete deletes a custom view

POST
/custom-views/delete

Request Body

application/jsonRequired

idstring

curl -X POST "https://api.runreveal.com/custom-views/delete" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": "string",
  "success": true
}

CustomViewsExternalSample fetches a handful of raw JSON rows from an external S3-compatible bucket so the CustomViewForm can feed them through the existing field-mapping pipeline (useFieldMappingSuggester / StepFieldMapping). Returns the same shape as the source-test endpoint so the frontend can reuse NDJSON parsing and field-mapping UI unchanged.

CustomViewsExternalSample fetches a handful of raw JSON rows from an external S3-compatible bucket so the CustomViewForm can feed them through the existing field-mapping pipeline (useFieldMappingSuggester / StepFieldMapping). Returns the same shape as the source-test endpoint so the frontend can reuse NDJSON parsing and field-mapping UI unchanged.

This endpoint does not persist anything; it is purely a probe.

POST
/custom-views/external/sample

Request Body

application/jsonRequired

externalStorageobject

externalStorageSecretsobject

curl -X POST "https://api.runreveal.com/custom-views/external/sample" \
  -H "Content-Type: application/json" \
  -d '{
    "externalStorage": {
      "authMode": "string",
      "bucket": "string",
      "compression": "string",
      "endpoint": "string",
      "format": "string",
      "partitionColumns": [
        "string"
      ],
      "pathGlob": "string",
      "prefix": "string",
      "provider": "string",
      "region": "string",
      "useHivePartitioning": true
    },
    "externalStorageSecrets": {
      "accessKeyId": "string",
      "roleArn": "string",
      "secretAccessKey": "string",
      "sessionToken": "string"
    }
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "error": "string",
    "sampleData": [
      "string"
    ],
    "sampleFormat": "string",
    "success": true
  },
  "success": true
}

CustomViewsGet retrieves a custom view in the current workspace by ID.

CustomViewsGet retrieves a custom view in the current workspace by ID.

GET
/custom-views/get
curl -X GET "https://api.runreveal.com/custom-views/get?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "columns": [
      {
        "description": "string",
        "name": "string",
        "sql": "string",
        "type": "string"
      }
    ],
    "createdAt": {},
    "description": "string",
    "externalStorage": {
      "authMode": "string",
      "bucket": "string",
      "compression": "string",
      "endpoint": "string",
      "format": "string",
      "partitionColumns": [
        "string"
      ],
      "pathGlob": "string",
      "prefix": "string",
      "provider": "string",
      "region": "string",
      "useHivePartitioning": true
    },
    "id": "string",
    "kind": "string",
    "lastSyncError": "string",
    "lastSyncedAt": {},
    "name": "string",
    "sourceId": "string",
    "sourceType": "string",
    "syncStatus": "string",
    "updatedAt": {},
    "workspaceId": "string"
  },
  "success": true
}

CustomViewsList lists the custom views in the current workspace, optionally filtered by source ID or name.

CustomViewsList lists the custom views in the current workspace, optionally filtered by source ID or name.

GET
/custom-views/list

Query Parameters

namestring

sourceIDstring

curl -X GET "https://api.runreveal.com/custom-views/list?name=string&sourceID=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "columns": [
        {
          "description": "string",
          "name": "string",
          "sql": "string",
          "type": "string"
        }
      ],
      "createdAt": {},
      "description": "string",
      "externalStorage": {
        "authMode": "string",
        "bucket": "string",
        "compression": "string",
        "endpoint": "string",
        "format": "string",
        "partitionColumns": [
          "string"
        ],
        "pathGlob": "string",
        "prefix": "string",
        "provider": "string",
        "region": "string",
        "useHivePartitioning": true
      },
      "id": "string",
      "kind": "string",
      "lastSyncError": "string",
      "lastSyncedAt": {},
      "name": "string",
      "sourceId": "string",
      "sourceType": "string",
      "syncStatus": "string",
      "updatedAt": {},
      "workspaceId": "string"
    }
  ],
  "success": true
}

CustomViewsTest tests a custom view with sample data from the last 24 hours

CustomViewsTest tests a custom view with sample data from the last 24 hours

POST
/custom-views/test

Request Body

application/jsonRequired

columnsarray<object>

externalStorageobject

externalStorageSecretsobject

kindstring

sourceIdstring

sourceTypestring

curl -X POST "https://api.runreveal.com/custom-views/test" \
  -H "Content-Type: application/json" \
  -d '{
    "columns": [
      {
        "description": "string",
        "name": "string",
        "sql": "string",
        "type": "string"
      }
    ],
    "externalStorage": {
      "authMode": "string",
      "bucket": "string",
      "compression": "string",
      "endpoint": "string",
      "format": "string",
      "partitionColumns": [
        "string"
      ],
      "pathGlob": "string",
      "prefix": "string",
      "provider": "string",
      "region": "string",
      "useHivePartitioning": true
    },
    "externalStorageSecrets": {
      "accessKeyId": "string",
      "roleArn": "string",
      "secretAccessKey": "string",
      "sessionToken": "string"
    },
    "kind": "string",
    "sourceId": "string",
    "sourceType": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "columnTypes": [
      "string"
    ],
    "columns": [
      "string"
    ],
    "message": "string",
    "rowCount": 0,
    "rows": [
      [
        {}
      ]
    ]
  },
  "success": true
}

CustomViewsUpdate updates an existing custom view

CustomViewsUpdate updates an existing custom view

POST
/custom-views/update

Request Body

application/jsonRequired

columnsarray<object>

descriptionstring

externalStorageobject

externalStorageSecretsobject

idstring

kindstring

namestring

sourceIdstring

sourceTypestring

curl -X POST "https://api.runreveal.com/custom-views/update" \
  -H "Content-Type: application/json" \
  -d '{
    "columns": [
      {
        "description": "string",
        "name": "string",
        "sql": "string",
        "type": "string"
      }
    ],
    "description": "string",
    "externalStorage": {
      "authMode": "string",
      "bucket": "string",
      "compression": "string",
      "endpoint": "string",
      "format": "string",
      "partitionColumns": [
        "string"
      ],
      "pathGlob": "string",
      "prefix": "string",
      "provider": "string",
      "region": "string",
      "useHivePartitioning": true
    },
    "externalStorageSecrets": {
      "accessKeyId": "string",
      "roleArn": "string",
      "secretAccessKey": "string",
      "sessionToken": "string"
    },
    "id": "string",
    "kind": "string",
    "name": "string",
    "sourceId": "string",
    "sourceType": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "columns": [
      {
        "description": "string",
        "name": "string",
        "sql": "string",
        "type": "string"
      }
    ],
    "createdAt": {},
    "description": "string",
    "externalStorage": {
      "authMode": "string",
      "bucket": "string",
      "compression": "string",
      "endpoint": "string",
      "format": "string",
      "partitionColumns": [
        "string"
      ],
      "pathGlob": "string",
      "prefix": "string",
      "provider": "string",
      "region": "string",
      "useHivePartitioning": true
    },
    "id": "string",
    "kind": "string",
    "lastSyncError": "string",
    "lastSyncedAt": {},
    "name": "string",
    "sourceId": "string",
    "sourceType": "string",
    "syncStatus": "string",
    "updatedAt": {},
    "workspaceId": "string"
  },
  "success": true
}