Hevo Edge

https://hevo-edge.readme.io
Admin
Hevo Edge provides APIs to build, manage, and monitor Edge Pipelines, enabling users to configure...
Tokens:46,415
Snippets:106
Trust Score:9.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### GET /api/v1/pipelines

Source: https://hevo-edge.readme.io/reference/get_api-v1-pipelines

Retrieves details of all Pipelines in your workspace, including their Source and Destination details. Supports pagination.

```APIDOC
## GET /api/v1/pipelines

### Description
Retrieves details of all Pipelines in your workspace, including their Source and Destination details. Supports pagination.

### Method
GET

### Endpoint
/api/v1/pipelines

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - Cursor for paginated results.
- **limit** (integer) - Optional - Number of results to return per page.

### Request Example
```json
{
  "example": "GET /api/v1/pipelines?limit=10&cursor=some_cursor_value"
}
```

### Response
#### Success Response (200)
- **data** (array) - List of Pipelines and their details.
  - **id** (integer) - Unique identifier of the Pipeline.
  - **name** (string) - Display name of the Pipeline.
  - **status** (string) - Current status of the Pipeline.
  - **source** (object) - Source details configured in the Pipeline.
    - **name** (string) - Name specified for the Source in Hevo.
    - **connector_id** (string) - Identifier of the connector used to ingest data from this Source.
    - **source_type** (string) - Variant of the Source you are using.
  - **destination** (object) - Destination details configured in the Pipeline.
    - **id** (integer) - Unique identifier of the Destination.
    - **name** (string) - Name specified for the Destination in Hevo.
    - **connector_id** (string) - Identifier of the connector used to ingest data from this Destination.

#### Response Example
```json
{
  "example": {
    "data": [
      {
        "id": 12345,
        "name": "Customer Orders Pipeline",
        "status": "INITIALIZED",
        "source": {
          "name": "My Source",
          "connector_id": "SOURCE_CONNECTOR_POSTGRES",
          "source_type": "AWS_RDS_POSTGRES"
        },
        "destination": {
          "id": 123,
          "name": "My Destination",
          "connector_id": "DESTINATION_CONNECTOR_SNOWFLAKE"
        }
      }
    ]
  }
}
```
```

--------------------------------

### GET /api/v1/pipelines/{pipeline_id}

Source: https://hevo-edge.readme.io/reference/get_api-v1-pipelines-pipeline-id

Retrieves complete configuration details of a Pipeline using its `pipeline_id`, including Source, Destination, and Pipeline settings.

```APIDOC
## GET /api/v1/pipelines/{pipeline_id}

### Description
Retrieves complete configuration details of a Pipeline using its `pipeline_id`, including Source, Destination, and Pipeline settings.

### Method
GET

### Endpoint
/api/v1/pipelines/{pipeline_id}

### Parameters
#### Path Parameters
- **pipeline_id** (integer) - Required - Unique identifier of the Pipeline.

### Request Example
```json
{
  "example": "No request body needed for GET request."
}
```

### Response
#### Success Response (200)
- **Pipeline details** (object) - Contains the complete configuration of the pipeline.

#### Response Example
```json
{
  "example": "{
    \"pipeline_id\": 12345,
    \"name\": \"My Pipeline\",
    \"source\": { ... },
    \"destination\": { ... },
    \"config\": { ... }
  }"
}
```
```

--------------------------------

### List All Destinations (Ruby)

Source: https://hevo-edge.readme.io/reference/destinations

Retrieves details for all Destinations in your workspace using Ruby. This example utilizes the Net::HTTP library to perform the API request.

```ruby
require 'net/http'
require 'uri'

uri = URI.parse('https://us.hevodata.com/api/v1/destinations')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Basic YOUR_BASE64_ENCODED_CREDENTIALS'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body
```

--------------------------------

### MySQL Source Configuration

Source: https://hevo-edge.readme.io/reference/patch_api-v1-pipelines-pipeline-id-sources

This section details the configuration parameters required to set up a MySQL data source. It includes base source information, database credentials, SSH tunneling options, and SSL settings.

```APIDOC
## POST /sources/mysql

### Description
Configure a new MySQL data source.

### Method
POST

### Endpoint
/sources/mysql

### Parameters
#### Request Body
- **name** (string) - Required - Unique name for your Source, not exceeding 255 characters.
- **config** (object) - Required - Configuration settings for MySQL.
  - **database_password** (string) - Required - Password for your database user.
  - **ssh_host** (string) - Optional - SSH host for tunneling.
  - **ssh_port** (integer) - Optional - SSH port for tunneling.
  - **ssh_user** (string) - Optional - SSH user for tunneling.
  - **ssh_authentication** (string) - Optional - SSH authentication method (e.g., "password", "publickey").
  - **ssh_key** (string) - Optional - SSH private key for public key authentication.
  - **ssl_mode** (string) - Optional - SSL mode for connection (e.g., "require", "verify-full").
  - **ssl_certificate** (string) - Optional - SSL certificate.
  - **ssl_key** (string) - Optional - SSL key.
  - **ssl_root_cert** (string) - Optional - SSL root certificate.

### Request Example
```json
{
  "name": "My MySQL Source",
  "config": {
    "host": "your_mysql_host",
    "port": 3306,
    "database_name": "your_database_name",
    "username": "your_db_user",
    "database_password": "my_secure_password",
    "ssh_host": "your_ssh_host",
    "ssh_port": 22,
    "ssh_user": "ssh_user",
    "ssh_authentication": "password",
    "ssl_mode": "require"
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the created source.
- **name** (string) - Name of the source.
- **created_by_email** (string) - Email address of the user who created the Source.
- **updated_by_email** (string) - Email address of the user who last updated the Source.
- **created_ts** (integer) - Timestamp when the Source was created (in milliseconds).
- **updated_ts** (integer) - Timestamp when the Source was last updated (in milliseconds).

#### Response Example
```json
{
  "id": "src_67890fghij",
  "name": "My MySQL Source",
  "created_by_email": "user@example.com",
  "updated_by_email": "user@example.com",
  "created_ts": 1756833130123,
  "updated_ts": 1756833330123
}
```
```

--------------------------------

### GET /pipelines/{pipeline_id}/objects

Source: https://hevo-edge.readme.io/reference/get_api-v1-pipelines-pipeline-id-objects

Retrieves a list of objects associated with a specific pipeline. Supports pagination and filtering.

```APIDOC
## GET /pipelines/{pipeline_id}/objects

### Description
Retrieves a list of objects associated with a specific pipeline. Supports pagination and filtering.

### Method
GET

### Endpoint
/pipelines/{pipeline_id}/objects

### Parameters
#### Path Parameters
- **pipeline_id** (integer) - Required - Unique identifier of the Pipeline.

#### Query Parameters
- **cursor** (string) - Optional - Value you can use to fetch the next set of results. Specify this value in the `cursor` query parameter to fetch additional results. This is `null` when no more results are available.
- **limit** (integer) - Optional - The maximum number of results to return. Defaults to 100. Maximum value is 500.

### Request Example
```json
{
  "example": "GET /pipelines/12345/objects?limit=10&cursor=bmV4dF9jdXJzb3I="
}
```

### Response
#### Success Response (200)
- **next_cursor** (string) - Value you can use to fetch the next set of results. Specify this value in the `cursor` query parameter to fetch additional results. This is `null` when no more results are available.
- **has_more** (boolean) - Indicates whether more results are available.
- **data** (array) - An array of object details.
  - **k0** (string) - Name of the Source object.
  - **k1** (string, nullable) - Grouping information for the object in the Source, such as the schema name.
  - **k2** (string, nullable) - Higher-level grouping information for the object in the Source, such as the database name.
  - **destination_namespace** (object) - Identifies the replicated object in the Destination using the same three-level structure as in the Source.
    - **k0** (string) - Name of the table created in the Destination for this object.
    - **k1** (string, nullable) - Grouping information for the object in the Destination, such as the schema name.
    - **k2** (string, nullable) - Higher-level grouping information for the object in the Destination, such as the database name.

#### Response Example
```json
{
  "example": {
    "next_cursor": "bmV4dF9jdXJzb3I=",
    "has_more": true,
    "data": [
      {
        "k0": "demo_table",
        "k1": "demo_schema",
        "k2": "demo_database",
        "destination_namespace": {
          "k0": "demo_table1",
          "k1": "demo_schema1",
          "k2": "demo_database1"
        }
      }
    ]
  }
}
```
```

--------------------------------

### PostgreSQL Source Configuration

Source: https://hevo-edge.readme.io/reference/patch_api-v1-pipelines-pipeline-id-sources

This section details the configuration parameters required to set up a PostgreSQL data source. It includes base source information, database credentials, SSH tunneling options, SSL settings, and Write-Ahead Log (WAL) monitoring configurations.

```APIDOC
## POST /sources/postgres

### Description
Configure a new PostgreSQL data source.

### Method
POST

### Endpoint
/sources/postgres

### Parameters
#### Request Body
- **name** (string) - Required - Unique name for your Source, not exceeding 255 characters.
- **config** (object) - Required - Configuration settings for PostgreSQL.
  - **database_password** (string) - Required - Password for your database user.
  - **ssh_host** (string) - Optional - SSH host for tunneling.
  - **ssh_port** (integer) - Optional - SSH port for tunneling.
  - **ssh_user** (string) - Optional - SSH user for tunneling.
  - **ssh_authentication** (string) - Optional - SSH authentication method (e.g., "password", "publickey").
  - **ssh_key** (string) - Optional - SSH private key for public key authentication.
  - **ssl_mode** (string) - Optional - SSL mode for connection (e.g., "require", "verify-full").
  - **ssl_certificate** (string) - Optional - SSL certificate.
  - **ssl_key** (string) - Optional - SSL key.
  - **ssl_root_cert** (string) - Optional - SSL root certificate.
  - **wal_slot_threshold_gb** (integer) - Optional - Maximum size of the Write-Ahead Logs, in GB, that you want Hevo to monitor. Defaults to 10.
  - **wal_alert_threshold_percent** (integer) - Optional - Usage percentage of the WAL size at which alerts are triggered. Defaults to 80.
  - **wal_alert_send_email** (boolean) - Optional - If set to true, Hevo sends an email when the threshold is exceeded. Defaults to true.

### Request Example
```json
{
  "name": "My PostgreSQL Source",
  "config": {
    "host": "your_postgres_host",
    "port": 5432,
    "database_name": "your_database_name",
    "username": "your_db_user",
    "database_password": "my_secure_password",
    "ssh_host": "your_ssh_host",
    "ssh_port": 22,
    "ssh_user": "ssh_user",
    "ssh_authentication": "password",
    "ssl_mode": "require",
    "wal_slot_threshold_gb": 15,
    "wal_alert_threshold_percent": 90,
    "wal_alert_send_email": true
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the created source.
- **name** (string) - Name of the source.
- **created_by_email** (string) - Email address of the user who created the Source.
- **updated_by_email** (string) - Email address of the user who last updated the Source.
- **created_ts** (integer) - Timestamp when the Source was created (in milliseconds).
- **updated_ts** (integer) - Timestamp when the Source was last updated (in milliseconds).

#### Response Example
```json
{
  "id": "src_12345abcde",
  "name": "My PostgreSQL Source",
  "created_by_email": "user@example.com",
  "updated_by_email": "user@example.com",
  "created_ts": 1756833130123,
  "updated_ts": 1756833330123
}
```
```

--------------------------------

### GET /api/v1/destinations

Source: https://hevo-edge.readme.io/reference/get_api-v1-destinations

Retrieves details for all Destinations in your workspace, including their ID, name, type, and status. Supports pagination.

```APIDOC
## GET /api/v1/destinations

### Description
Retrieves details for all Destinations in your workspace, including their ID, name, type, and status. Supports pagination.

### Method
GET

### Endpoint
/api/v1/destinations

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - Value used to retrieve the next set of results. Provide the `next_cursor` value returned in the previous API response.
- **limit** (integer) - Optional - Maximum number of results the API should return. If not set, the API returns 100 items. (min: 1, max: 500, default: 100)

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **data** (array) - List containing the details of each Destination.
  - **id** (integer) - Unique identifier of the Destination.
  - **name** (string) - Name specified for the Destination in Hevo.
  - **connector_id** (string) - Identifier of the connector used to load data into this Destination.
  - **destination_type** (string) - Type of Destination you are using.
  - **status** (string) - Current status of the Destination.
- **next_cursor** (string) - Value to be used for the `cursor` parameter to retrieve the next page of results.

#### Response Example
```json
{
  "data": [
    {
      "id": 123,
      "name": "My Snowflake Destination",
      "connector_id": "snowflake",
      "destination_type": "SNOWFLAKE",
      "status": "CREATED"
    }
  ],
  "next_cursor": "bmV4dF9jdXJzb3I="
}
```
```

--------------------------------

### PostgreSQL Source Configuration

Source: https://hevo-edge.readme.io/reference/post_api-v1-pipelines

This section details the configuration parameters for setting up a PostgreSQL source in Hevo.

```APIDOC
## POST /api/v1/sources

### Description
Creates a new data source for Hevo to ingest data from.

### Method
POST

### Endpoint
/api/v1/sources

### Parameters
#### Request Body
- **name** (string) - Required - Unique name for your Source, not exceeding 255 characters.
- **connector_id** (string) - Required - Connector used by Hevo to ingest data from your Source.
- **source_type** (string) - Optional - Select the variant of the Source you want the Pipeline to ingest data from. Defaults to 'POSTGRES'.
- **config** (object) - Required - Configuration settings for PostgreSQL.
  - **wal_slot_threshold_gb** (integer) - Optional - Maximum size of the Write-Ahead Logs, in GB, that you want Hevo to monitor. Minimum: 1.
  - **wal_alert_threshold_percent** (integer) - Optional - Usage percentage of the WAL size at which alerts are triggered. Minimum: 1, Maximum: 100.
  - **wal_alert_send_email** (boolean) - Optional - If set to true, Hevo sends an email when the threshold is exceeded. Defaults to true.

### Request Example
```json
{
  "name": "My PostgreSQL Source",
  "connector_id": "SOURCE_CONNECTOR_POSTGRES",
  "source_type": "POSTGRES",
  "config": {
    "wal_slot_threshold_gb": 10,
    "wal_alert_threshold_percent": 80,
    "wal_alert_send_email": true
  }
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - Unique identifier for the created source.
- **name** (string) - Name of the source.
- **connector_id** (string) - Connector ID used.
- **source_type** (string) - Type of the source.
- **status** (string) - Current status of the Source.
- **created_by_email** (string) - Email address of the user who created the Source.
- **created_ts** (integer) - Timestamp when the Source was created (in milliseconds).
- **updated_by_email** (string) - Email address of the user who last updated the Source.
- **updated_ts** (integer) - Timestamp when the Source was last updated (in milliseconds).

#### Response Example
```json
{
  "id": "src_12345abcde",
  "name": "My PostgreSQL Source",
  "connector_id": "SOURCE_CONNECTOR_POSTGRES",
  "source_type": "POSTGRES",
  "status": "CREATED",
  "created_by_email": "demo@example.com",
  "created_ts": 1756833130123,
  "updated_by_email": "demo@example.com",
  "updated_ts": 1756833130123
}
```
```

--------------------------------

### Get Pipeline Object Details

Source: https://hevo-edge.readme.io/reference/get_api-v1-pipelines-pipeline-id-objects-object-id

Retrieves detailed information about a specific object within a pipeline, including its source and destination namespaces.

```APIDOC
## GET /pipelines/{pipeline_id}/objects/{object_id}

### Description
Retrieves detailed information about a specific object within a pipeline, including its source and destination namespaces.

### Method
GET

### Endpoint
`/pipelines/{pipeline_id}/objects/{object_id}`

### Parameters
#### Path Parameters
- **pipeline_id** (integer) - Required - Unique identifier of the Pipeline.
- **object_id** (string) - Required - Unique identifier of the object you want to retrieve.

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **destination_type** (string) - Data type of the field in the Destination.
- **status** (string) - Current status of the field.
- **primary_key** (boolean) - Indicates whether the field is used as a primary key for the object.
- **response_pipeline_object_namespace** (object) - Identifies the object in the Source system using a three-level structure.
  - **k0** (string) - Name of the Source object.
  - **k1** (string) - Grouping information for the object in the Source, such as the schema name.
  - **k2** (string) - Higher-level grouping information for the object in the Source, such as the database name.
- **response_pipeline_object_destination_namespace** (object) - Identifies the replicated object in the Destination using the same three-level structure as in the Source.
  - **k0** (string) - Name of the table created in the Destination for this object.
  - **k1** (string) - Grouping information for the object in the Destination, such as the schema name.
  - **k2** (string) - Higher-level grouping information for the object in the Destination, such as the database name.

#### Response Example
```json
{
  "destination_type": "NUMBER(38,0)",
  "status": "ACTIVE",
  "primary_key": true,
  "response_pipeline_object_namespace": {
    "k0": "demo_table",
    "k1": "demo_schema",
    "k2": "demo_database"
  },
  "response_pipeline_object_destination_namespace": {
    "k0": "demo_table1",
    "k1": "demo_schema1",
    "k2": "demo_database1"
  }
}
```
```

--------------------------------

### Oracle Source Configuration

Source: https://hevo-edge.readme.io/reference/patch_api-v1-pipelines-pipeline-id-sources

This section details the configuration parameters required to set up an Oracle data source. It includes base source information and connection details.

```APIDOC
## POST /sources/oracle

### Description
Configure a new Oracle data source.

### Method
POST

### Endpoint
/sources/oracle

### Parameters
#### Request Body
- **name** (string) - Required - Unique name for your Source, not exceeding 255 characters.
- **config** (object) - Required - Configuration settings for Oracle.
  - **connection_string** (string) - Required - The Oracle connection string (e.g., "//host:port/service_name").
  - **username** (string) - Required - Database username.
  - **password** (string) - Required - Database password.

### Request Example
```json
{
  "name": "My Oracle Source",
  "config": {
    "connection_string": "//your_oracle_host:1521/your_service_name",
    "username": "your_oracle_user",
    "password": "my_secure_password"
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the created source.
- **name** (string) - Name of the source.
- **created_by_email** (string) - Email address of the user who created the Source.
- **updated_by_email** (string) - Email address of the user who last updated the Source.
- **created_ts** (integer) - Timestamp when the Source was created (in milliseconds).
- **updated_ts** (integer) - Timestamp when the Source was last updated (in milliseconds).

#### Response Example
```json
{
  "id": "src_11223ddee",
  "name": "My Oracle Source",
  "created_by_email": "user@example.com",
  "updated_by_email": "user@example.com",
  "created_ts": 1756833130123,
  "updated_ts": 1756833330123
}
```
```

--------------------------------

### Google BigQuery Destination Configuration

Source: https://hevo-edge.readme.io/reference/post_api-v1-destinations

This section details the configuration parameters required to set up Google BigQuery as a destination. It covers essential fields like `destination_type`, `project_id`, and `service_account_private_key`, as well as optional settings like `location` and `use_existing_bucket`.

```APIDOC
## POST /api/destinations/bigquery

### Description
Configure Google BigQuery as a data destination for your pipeline. This involves providing your Google Cloud project details and authentication credentials.

### Method
POST

### Endpoint
/api/destinations/bigquery

### Parameters
#### Request Body
- **destination_type** (string) - Required - Identifier of the Destination type. Must be `BIGQUERY`.
- **config** (object) - Required - Configuration settings for Google BigQuery.
  - **project_id** (string) - Required - Your Google Cloud project ID.
  - **location** (string) - Optional - Region where Hevo will create the dataset. Defaults to `US`.
  - **use_existing_bucket** (boolean) - Optional - If true, Hevo uses your own Google Cloud Storage bucket for staging files. Defaults to `false`.
  - **bucket_name** (string) - Optional - Name of your GCS bucket. Required when `use_existing_bucket` is true.
  - **service_account_private_key** (string) - Required - Private key of the service account in JSON format for authentication.

### Request Example
```json
{
  "destination_type": "BIGQUERY",
  "config": {
    "project_id": "gcp-project-12345",
    "location": "US",
    "use_existing_bucket": false,
    "service_account_private_key": "{ \"type\": \"service_account\", \"project_id\": \"example-gcp-project\", ... }"
  }
}
```

### Response
#### Success Response (200)
- **destination_id** (string) - The unique identifier for the created BigQuery destination.
- **message** (string) - A confirmation message indicating successful creation.

#### Response Example
```json
{
  "destination_id": "dest-12345abcde",
  "message": "BigQuery destination created successfully."
}
```
```

--------------------------------

### MySQL Source Configuration

Source: https://hevo-edge.readme.io/reference/post_api-v1-pipelines

Configure a MySQL data source for data ingestion. This includes database credentials and host information.

```APIDOC
## POST /api/sources/mysql

### Description
Configure a MySQL data source for data ingestion. This includes database credentials and host information.

### Method
POST

### Endpoint
/api/sources/mysql

### Parameters
#### Request Body
- **source_type** (string) - Optional - Select the variant of the Source you want the Pipeline to ingest data from. Defaults to "MYSQL". Accepts: "MYSQL", "AWS_RDS_MYSQL", "AURORA", "GCP_MYSQL", "AZURE_MYSQL".
- **database_host** (string) - Required - DNS name or IP address of your MySQL database host.
- **database_name** (string) - Required - Name of the database from which you want to replicate data.
- **database_user** (string) - Required - User with permissions to read data from your database.
- **database_password** (string) - Required - Password for your database user.
- **database_port** (integer) - Optional - Port on which your MySQL server listens for connections. Defaults to 3306.

### Request Example
```json
{
  "source_type": "MYSQL",
  "database_host": "mysql.westeros.inc",
  "database_name": "my_database",
  "database_user": "mysql_user",
  "database_password": "my_secure_password",
  "database_port": 3306
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating successful configuration.

#### Response Example
```json
{
  "message": "MySQL source configured successfully."
}
```
```

--------------------------------

### GET /jobs/{job_id}/statistics

Source: https://hevo-edge.readme.io/reference/get_api-v1-pipelines-pipeline-id-jobs-job-id

Retrieves detailed statistics for a specific job, including event counts, processing duration, and latency metrics.

```APIDOC
## GET /jobs/{job_id}/statistics

### Description
Retrieves detailed statistics for a specific job, including event counts, processing duration, and latency metrics.

### Method
GET

### Endpoint
/jobs/{job_id}/statistics

### Parameters
#### Path Parameters
- **job_id** (string) - Required - The unique identifier of the job.

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET /jobs/abc123xyz/statistics
```

### Response
#### Success Response (200)
- **objects_processed** (integer) - Number of objects processed during the job.
- **objects_skipped** (integer) - Number of objects skipped during processing.
- **objects_failed** (integer) - Number of objects that failed processing.
- **billable_events** (integer) - Number of billable Events in the job.
- **non_billable_events** (integer) - Number of non-billable Events in the job.
- **duration** (integer) - Time taken to execute the job (in milliseconds).
- **min_latency** (integer, nullable) - Minimum object-level latency (in milliseconds).
- **max_latency** (integer, nullable) - Maximum object-level latency (in milliseconds).
- **mean_latency** (integer, nullable) - Average of the mean latencies across all Source objects in a job (in milliseconds).

#### Response Example
```json
{
  "objects_processed": 1000,
  "objects_skipped": 50,
  "objects_failed": 5,
  "billable_events": 800,
  "non_billable_events": 200,
  "duration": 300000,
  "min_latency": 100,
  "max_latency": 5000,
  "mean_latency": 1500
}
```
```

--------------------------------

### Get Pipeline Job Stages

Source: https://hevo-edge.readme.io/reference/get_api-v1-pipelines-pipeline-id-jobs-job-id-objects

Retrieves a list of stages for a specific pipeline job, including their status, event counts, and duration. Supports pagination.

```APIDOC
## GET /pipelines/{pipeline_id}/jobs/{job_id}/stages

### Description
Retrieves a list of stages for a specific pipeline job, including their status, event counts, and duration. Supports pagination.

### Method
GET

### Endpoint
`/pipelines/{pipeline_id}/jobs/{job_id}/stages`

### Parameters
#### Path Parameters
- **pipeline_id** (integer) - Required - Unique identifier of the Pipeline.
- **job_id** (string) - Required - Unique identifier of the job.

#### Query Parameters
- **cursor** (string) - Optional - Value used to retrieve the next set of results. Provide the `next_cursor` value returned in the previous API response.
- **limit** (integer) - Optional - Maximum number of results the API should return. If not set, the API returns 100 items. (Minimum: 1, Maximum: 500, Default: 100)

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **data** (array) - List of pipeline job stages.
  - **status** (string) - Status of the ingestion stage.
  - **events_input** (integer) - Number of Events received at the ingestion stage.
  - **events_output** (integer) - Number of Events successfully processed at the ingestion stage.
  - **events_failed** (integer) - Number of Events that failed during the ingestion stage.
  - **duration** (integer) - Time taken to process the ingestion stage (in milliseconds).
  - **min_latency** (integer) - Minimum Event-level latency (in milliseconds).
  - **max_latency** (integer) - Maximum Event-level latency (in milliseconds).
  - **mean_latency** (integer) - Average of the minimum and maximum latencies for the object (in milliseconds).
- **next_cursor** (string) - Value you can use to fetch the next set of results. Specify this value in the `cursor` query parameter to fetch additional results. This is `null` when no more results are available.
- **has_more** (boolean) - Indicates whether more results are available.

#### Response Example
```json
{
  "data": [
    {
      "status": "COMPLETED",
      "events_input": 100,
      "events_output": 95,
      "events_failed": 5,
      "duration": 30000,
      "min_latency": 50,
      "max_latency": 2000,
      "mean_latency": 500
    }
  ],
  "next_cursor": "bmV4dF9jdXJzb3I=",
  "has_more": true
}
```
```

--------------------------------

### PostgreSQL Source Configuration

Source: https://hevo-edge.readme.io/reference/post_api-v1-pipelines

Configure a PostgreSQL data source for data ingestion. This includes database credentials, host information, and publication details for change tracking.

```APIDOC
## POST /api/sources/postgresql

### Description
Configure a PostgreSQL data source for data ingestion. This includes database credentials, host information, and publication details for change tracking.

### Method
POST

### Endpoint
/api/sources/postgresql

### Parameters
#### Request Body
- **database_host** (string) - Required - DNS name or IP address of your PostgreSQL database host.
- **database_name** (string) - Required - Name of the database from which you want to replicate data.
- **database_user** (string) - Required - User with permissions to read data from your database.
- **database_password** (string) - Required - Password for your database user.
- **publication_key** (string) - Required - Name of the publication that tracks changes to the tables in your Source database.
- **database_port** (integer) - Optional - Port on which your PostgreSQL server listens for connections. Defaults to 5432.

### Request Example
```json
{
  "database_host": "postgresql.westeros.inc",
  "database_name": "my_database",
  "database_user": "postgresql_user",
  "database_password": "my_secure_password",
  "publication_key": "my_publication",
  "database_port": 5432
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating successful configuration.

#### Response Example
```json
{
  "message": "PostgreSQL source configured successfully."
}
```
```

--------------------------------

### Get Details of a Destination

Source: https://hevo-edge.readme.io/reference/get_api-v1-destinations-destination-id

Retrieves information for a specific Destination using its `destination_id`. The response includes the Destination’s name, type, status, and configuration details.

```APIDOC
## GET /api/v1/destinations/{destination_id}

### Description
Retrieves information for a specific Destination using its `destination_id`. The response includes the Destination’s name, type, status, and configuration details.

### Method
GET

### Endpoint
/api/v1/destinations/{destination_id}

### Parameters
#### Path Parameters
- **destination_id** (integer) - Required - Unique identifier of the Destination.

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier of the Destination.
- **name** (string) - Name specified for the Destination in Hevo.
- **connector_id** (string) - Identifier of the connector used to load data into this Destination.
- **destination_type** (string) - Type of Destination you are using.
- **status** (string) - Current status of the Destination.
- **config** (object) - Configuration details specific to the Destination type.
- **created_by_email** (string) - Email address of the user who created the Destination.
- **updated_by_email** (string) - Email address of the user who last updated the Destination.
- **created_ts** (integer) - Timestamp when the Destination was created (in milliseconds).
- **updated_ts** (integer) - Timestamp when the Destination was last updated (in milliseconds).

#### Response Example
```json
{
  "id": 123,
  "name": "My Snowflake Destination",
  "connector_id": "snowflake",
  "destination_type": "SNOWFLAKE",
  "status": "CREATED",
  "config": {},
  "created_by_email": "demo@example.com",
  "updated_by_email": "admin@example.com",
  "created_ts": 1756833130123,
  "updated_ts": 1756833330123
}
```
```

--------------------------------

### Oracle Configuration

Source: https://hevo-edge.readme.io/reference/patch_api-v1-pipelines-pipeline-id-sources

This section details the configuration object for Oracle, including database credentials, SSH, and SSL settings.

```APIDOC
## GET /websites/hevo-edge_readme_io/config/oracle

### Description
Retrieves the current Oracle configuration settings.

### Method
GET

### Endpoint
/websites/hevo-edge_readme_io/config/oracle

### Parameters
#### Query Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **config** (object) - Configuration settings for Oracle.
  - **database_password** (string) - Password for your database user.
  - **ssh_settings** (object) - SSH configuration details (see hevo_component_ssh schema).
  - **ssl_settings** (object) - SSL configuration details (see hevo_component_ssl schema).

#### Response Example
```json
{
  "config": {
    "database_password": "my_secure_password",
    "ssh_settings": {
      "host": "ssh.example.com",
      "port": 22,
      "user": "user"
    },
    "ssl_settings": {
      "enabled": true,
      "ca_cert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
    }
  }
}
```

## PUT /websites/hevo-edge_readme_io/config/oracle

### Description
Updates the Oracle configuration settings.

### Method
PUT

### Endpoint
/websites/hevo-edge_readme_io/config/oracle

### Parameters
#### Request Body
- **config** (object) - Configuration settings for Oracle.
  - **database_password** (string) - Required - Password for your database user.
  - **ssh_settings** (object) - Optional - SSH configuration details (see hevo_component_ssh schema).
  - **ssl_settings** (object) - Optional - SSL configuration details (see hevo_component_ssl schema).

### Request Example
```json
{
  "config": {
    "database_password": "new_secure_password",
    "ssh_settings": {
      "host": "new.ssh.example.com",
      "port": 2222,
      "user": "new_user"
    },
    "ssl_settings": {
      "enabled": false
    }
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating successful update.

#### Response Example
```json
{
  "message": "Oracle configuration updated successfully."
}
```
```

--------------------------------

### GET /jobs/{job_id}/status

Source: https://hevo-edge.readme.io/reference/get_api-v1-pipelines-pipeline-id-jobs

Fetches the status and performance metrics for a given job ID. This endpoint is useful for monitoring job progress and identifying potential issues.

```APIDOC
## GET /jobs/{job_id}/status

### Description
Fetches the status and performance metrics for a given job ID. This endpoint is useful for monitoring job progress and identifying potential issues.

### Method
GET

### Endpoint
/jobs/{job_id}/status

### Parameters
#### Path Parameters
- **job_id** (string) - Required - The unique identifier of the job.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - Current status of the job.
- **created_ts** (integer) - Timestamp when the job was created (in milliseconds).
- **updated_ts** (integer) - Timestamp when the job was last updated (in milliseconds).
- **events_ingested** (integer) - Number of Events ingested from the objects processed in the job.
- **events_loaded** (integer) - Number of Events loaded to the Destination for the objects processed in the job.
- **events_failed** (integer) - Number of Events that were not loaded to the Destination.
- **objects_success** (integer) - Number of objects processed successfully.
- **objects_queued** (integer) - Number of objects waiting to be processed.
- **objects_skipped** (integer) - Number of objects skipped during processing.
- **objects_failed** (integer) - Number of objects that failed processing.
- **billable_events** (integer) - Number of billable Events in the job.
- **non_billable_events** (integer) - Number of non-billable Events in the job.
- **duration** (integer) - Time taken to execute the job (in milliseconds).
- **min_latency** (integer, nullable) - Minimum object-level latency (in milliseconds).
- **max_latency** (integer, nullable) - Maximum object-level latency (in milliseconds).
- **mean_latency** (integer, nullable) - Average of the mean latencies across all Source objects in a job (in milliseconds).

#### Response Example
```json
{
  "status": "COMPLETED",
  "created_ts": 1756833130123,
  "updated_ts": 1756833330123,
  "events_ingested": 1000,
  "events_loaded": 950,
  "events_failed": 50,
  "objects_success": 5,
  "objects_queued": 2,
  "objects_skipped": 1,
  "objects_failed": 1,
  "billable_events": 800,
  "non_billable_events": 200,
  "duration": 300000,
  "min_latency": 100,
  "max_latency": 5000,
  "mean_latency": 1500
}
```
```

--------------------------------

### POST /api/v1/pipelines

Source: https://hevo-edge.readme.io/reference/post_api-v1-pipelines

Creates a new Pipeline with the specified Source, Destination, and Pipeline settings. This endpoint allows for the configuration of data ingestion from various sources to destinations.

```APIDOC
## POST /api/v1/pipelines

### Description
Creates a Pipeline with the specified Source, Destination, and Pipeline settings.

### Method
POST

### Endpoint
/api/v1/pipelines

### Parameters
#### Request Body
- **name** (string) - Required - Unique name for your Pipeline, not exceeding 255 characters.
- **source** (object) - Required - Configuration for the data source.
  - **name** (string) - Required - Name of the source.
  - **connector_id** (string) - Required - Identifier for the source connector (e.g., SOURCE_CONNECTOR_POSTGRES).
  - **config** (object) - Required - Specific configuration for the connector.
- **destination_id** (integer) - Required - Unique identifier of the Destination where you want to load data. Minimum value is 1.
- **destination_prefix** (string) - Required - Prefix for the destination.
- **load_mode** (string) - Required - Mode of data loading.
- **replication_type** (string) - Required - Type of data replication.
- **schema_evolution** (boolean) - Required - Whether to enable schema evolution.
- **schedule** (string) - Required - Schedule for data synchronization.
- **failure_handling_policy** (string) - Required - Policy for handling failures.

### Request Example
```json
{
  "name": "My Pipeline",
  "source": {
    "name": "Postgres Source",
    "connector_id": "SOURCE_CONNECTOR_POSTGRES",
    "config": {
      "host": "localhost",
      "port": 5432,
      "database": "mydb",
      "user": "myuser",
      "password": "mypassword"
    }
  },
  "destination_id": 123,
  "destination_prefix": "hevo_",
  "load_mode": "full_load",
  "replication_type": "incremental",
  "schema_evolution": true,
  "schedule": "daily",
  "failure_handling_policy": "retry"
}
```

### Response
#### Success Response (200)
- **pipeline_id** (string) - Unique identifier for the created pipeline.
- **name** (string) - Name of the pipeline.
- **source** (object) - Details of the source configuration.
- **destination_id** (integer) - Identifier of the destination.
- **created_at** (string) - Timestamp when the pipeline was created.

#### Response Example
```json
{
  "pipeline_id": "pi_abcdef123456",
  "name": "My Pipeline",
  "source": {
    "name": "Postgres Source",
    "connector_id": "SOURCE_CONNECTOR_POSTGRES"
  },
  "destination_id": 123,
  "created_at": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Pagination Parameters

Source: https://hevo-edge.readme.io/reference/get_api-v1-metadata-sources-connectors

This section details the query parameters used for pagination, including `cursor` for fetching subsequent pages and `limit` for controlling the number of items per page.

```APIDOC
## GET /example/endpoint

### Description
This endpoint retrieves a paginated list of items. You can control the number of items returned and specify a cursor to fetch subsequent pages of results.

### Method
GET

### Endpoint
/example/endpoint

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - Value used to retrieve the next set of results. Provide the `next_cursor` value returned in the previous API response.
- **limit** (integer) - Optional - Maximum number of results the API should return. If not set, the API returns 100 items. (Default: 100, Min: 1, Max: 500)

### Request Example
```json
{
  "example": "GET /example/endpoint?cursor=bmV4dF9jdXJzb3I=&limit=20"
}
```

### Response
#### Success Response (200)
- **next_cursor** (string) - Value you can use to fetch the next set of results. This is `null` when no more results are available.
- **has_more** (boolean) - Indicates whether more results are available.

#### Response Example
```json
{
  "example": {
    "next_cursor": "bmV4dF9jdXJzb3I=",
    "has_more": true
  }
}
```
```

--------------------------------

### List All Destinations (Python)

Source: https://hevo-edge.readme.io/reference/destinations

Retrieves details for all Destinations in your workspace using Python. This example uses the 'requests' library for making HTTP requests.

```python
import requests

url = "https://us.hevodata.com/api/v1/destinations"
headers = {
    "Authorization": "Basic YOUR_BASE64_ENCODED_CREDENTIALS"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```
Tokens:
Raw