Site stream data sources

List, create, update, and delete Stream API data sources on a site using the Platform API.

The data source management endpoint lets you link Stream API streams to sites programmatically. You can create, update, delete, and inspect data source connections.

This endpoint supports unified authentication.

List stream data sources

curl --header 'X-Auth-Token: value' \
--header 'Content-Type: application/json' \
--request GET 'https://platform-api.productsup.io/platform/v2/sites/1/streams'

{
    "success": true,
    "Sources": [
        {
            "id": 1,
            "site_id": 1,
            "description": "stream api",
            "source": "",
            "import_type": 1,
            "import_id": 331,
            "status": "active",
            "settings": [
                "stream : 1"
            ]
        }
    ],
    "meta": {
        "cursor": {
            "current": 0,
            "prev": 0,
            "next": 1,
            "count": 1
        }
    }
}

GET https://platform-api.productsup.io/platform/v2/sites/<siteId>/streams

Field	Type	Description
`siteId`	integer	Site identifier

See cursor parameters for pagination query fields.

HTTP headers

Name	Value
`Content-Type`	`application/json`

Response fields

Field	Type	Description
`success`	boolean	Indicates request status
`Sources`	array	List of data sources
`meta`	array	See cursor fields

Data source fields

Field	Type	Description
`id`	integer	Data source identifier
`site_id`	integer	Identifier of the site this data source belongs to
`description`	string	Description of the data source
`status`	string	See status values
`source`	string	URL of the data source
`import_type`	integer	See import type values
`import_id`	integer	Import method identifier
`settings`	array	All settings related to the data source

Status values

Value	Description
`active`	The data source is fully operational
`paused`	The data source is paused and data is not imported

Import type values

Value	Description
`1`	Main data feed
`2`	Additional data feed

Response status codes

Code	Message	Details
200	—	List returned successfully
401	Unauthorized	Invalid authentication token
403	You don't have the rights to access this resource	Insufficient permissions to access the site
404	The requested resource could not be found	The site does not exist

Create stream data source

curl --header 'X-Auth-Token: value' \
--header 'Content-Type: application/json' \
--request POST 'https://platform-api.productsup.io/platform/v2/sites/1/streams' \
--data-raw '{"import_type":1,"description":"stream api","stream_id":1,"status":"active"}'

{
    "success": true,
    "Sources": [
        {
            "id": 1,
            "site_id": 1,
            "description": "stream api",
            "source": "",
            "import_type": 1,
            "import_id": 331,
            "status": "active",
            "settings": ["stream : 1"]
        }
    ]
}

POST https://platform-api.productsup.io/platform/v2/sites/<siteId>/streams

Field	Type	Description
`siteId`	integer	Site identifier

HTTP headers

Name	Value
`Content-Type`	`application/json`

Request body fields

Field	Type	Description
`stream_id`	integer	Stream identifier
`import_type`	integer	See import type values. Defaults to `1`.
`description`	string	Description of the data source
`status`	string	See status values. Defaults to `active`.

See response fields and data source fields for the response structure.

Response status codes

Code	Message	Details
201	—	Data source created and linked to the site
401	Unauthorized	Invalid authentication token
403	You don't have the rights to access this resource	Insufficient permissions to access the site or stream
404	The requested resource could not be found	The site or stream does not exist
422	The stream datasource for the site already exists	The stream is already linked to this site

Update stream data source

curl --header 'X-Auth-Token: value' \
--header 'Content-Type: application/json' \
--request PUT 'https://platform-api.productsup.io/platform/v2/sites/1/streams/1' \
--data-raw '{"import_type":1,"description":"stream api","status":"active"}'

PUT https://platform-api.productsup.io/platform/v2/sites/<siteId>/streams/<streamId>

Field	Type	Description
`siteId`	integer	Site identifier
`streamId`	integer	Stream identifier

HTTP headers

Name	Value
`Content-Type`	`application/json`

Request body fields

Field	Type	Description
`import_type`	integer	See import type values
`description`	string	Description of the data source
`status`	string	See status values

See response fields and data source fields for the response structure.

Response status codes

Code	Message	Details
200	—	Data source updated successfully
401	Unauthorized	Invalid authentication token
403	You don't have the rights to access this resource	Insufficient permissions to access the site or stream
404	The requested resource could not be found	The site or stream does not exist
422	The stream datasource for the site doesn't exist	The stream is not linked to this site

Delete stream data source

curl --header 'X-Auth-Token: value' \
--header 'Content-Type: application/json' \
--request DELETE 'https://platform-api.productsup.io/platform/v2/sites/1/streams/1'

{
    "success": true,
    "message": "Resource was deleted successfully!"
}

DELETE https://platform-api.productsup.io/platform/v2/sites/<siteId>/streams/<streamId>

Field	Type	Description
`siteId`	integer	Site identifier
`streamId`	integer	Stream identifier

HTTP headers

Name	Value
`Content-Type`	`application/json`

Response fields

Field	Type	Description
`success`	boolean	Indicates request status
`message`	string	Confirmation message

Response status codes

Code	Message	Details
200	—	Data source deleted successfully
401	Unauthorized	Invalid authentication token
403	You don't have the rights to access this resource	Insufficient permissions to access the site or stream
404	The requested resource could not be found	The site or stream does not exist
422	The stream datasource for the site doesn't exist	The stream is not linked to this site

Site stream data sources

On this page