Data connections

Server

Download schema

List data connections

GET

https://app.openpush.ai

/v1/apps/{app_id}/data/connections

X-OP-API-Key (header)

List data connections › path Parameters

app_id

string · required

List data connections › Responses

Successful Response

No data returned

Create a data connection

POST

https://app.openpush.ai

/v1/apps/{app_id}/data/connections

X-OP-API-Key (header)

Create a data connection › path Parameters

app_id

string · required

Create a data connection › Request Body

Create a data connection › Responses

Successful Response

No data returned

Read data connection delivery report

GET

https://app.openpush.ai

/v1/apps/{app_id}/data/connections/{cid}

X-OP-API-Key (header)

Read data connection delivery report › path Parameters

app_id

string · required

cid

string · required

Read data connection delivery report › query Parameters

days

integer

Default: 7

offset

integer

Default: 0

Read data connection delivery report › Responses

Successful Response

No data returned

Update a data connection

PUT

https://app.openpush.ai

/v1/apps/{app_id}/data/connections/{cid}

X-OP-API-Key (header)

Update a data connection › path Parameters

app_id

string · required

cid

string · required

Update a data connection › Request Body

Update a data connection › Responses

Successful Response

No data returned

Activate, pause, retry or delete a connection

POST

https://app.openpush.ai

/v1/apps/{app_id}/data/connections/{cid}/actions/{action}

X-OP-API-Key (header)

Activate, pause, retry or delete a connection › path Parameters

app_id

string · required

cid

string · required

action

string · required

Activate, pause, retry or delete a connection › Request Body optional

No request fields.

Activate, pause, retry or delete a connection › Responses

Successful Response

No data returned

Test a saved connection

POST

https://app.openpush.ai

/v1/apps/{app_id}/data/connections/{cid}/test

X-OP-API-Key (header)

Test a saved connection › path Parameters

app_id

string · required

cid

string · required

Test a saved connection › Request Body

Test a saved connection › Responses

Successful Response

No data returned

Receive Amplitude or custom integration events

POST

https://app.openpush.ai

/v1/apps/{app_id}/data/sources/{cid}/events

Bearer

Receive Amplitude or custom integration events › path Parameters

app_id

string · required

cid

string · required

Receive Amplitude or custom integration events › Request Body

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array

Properties for Variant 1:

Receive Amplitude or custom integration events › Responses

Successful Response

No data returned

Import & export

Create a data connection

POST

https://app.openpush.ai

/v1/apps/{app_id}/data/connections

X-OP-API-Key (header)

Create a data connection › path Parameters

app_id

string · required

Create a data connection › Request Body

Create a data connection › Responses

Successful Response

No data returned

Read data connection delivery report

GET

https://app.openpush.ai

/v1/apps/{app_id}/data/connections/{cid}

X-OP-API-Key (header)

Read data connection delivery report › path Parameters

app_id

string · required

cid

string · required

Read data connection delivery report › query Parameters

days

integer

Default: 7

offset

integer

Default: 0

Read data connection delivery report › Responses

Successful Response

No data returned

Update a data connection

PUT

https://app.openpush.ai

/v1/apps/{app_id}/data/connections/{cid}

X-OP-API-Key (header)

Update a data connection › path Parameters

app_id

string · required

cid

string · required

Update a data connection › Request Body

Update a data connection › Responses

Successful Response

No data returned

Activate, pause, retry or delete a connection

POST

https://app.openpush.ai

/v1/apps/{app_id}/data/connections/{cid}/actions/{action}

X-OP-API-Key (header)

Activate, pause, retry or delete a connection › path Parameters

app_id

string · required

cid

string · required

action

string · required

Activate, pause, retry or delete a connection › Request Body optional

No request fields.

Activate, pause, retry or delete a connection › Responses

Successful Response

No data returned

Test a saved connection

POST

https://app.openpush.ai

/v1/apps/{app_id}/data/connections/{cid}/test

X-OP-API-Key (header)

Test a saved connection › path Parameters

app_id

string · required

cid

string · required

Test a saved connection › Request Body

Test a saved connection › Responses

Successful Response

No data returned

Receive Amplitude or custom integration events

POST

https://app.openpush.ai

/v1/apps/{app_id}/data/sources/{cid}/events

Bearer

Receive Amplitude or custom integration events › path Parameters

app_id

string · required

cid

string · required

Receive Amplitude or custom integration events › Request Body

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array

Properties for Variant 1:

Receive Amplitude or custom integration events › Responses

Successful Response

No data returned