Read or list conversion product objects. (See API authentication for general information how to use these APIs.)
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
id |
String |
No |
Identifier of a conversion product. |
|
siteGroupId |
String |
No |
Identifier of a site group. |
|
siteId |
String |
No |
Identifier of a site. |
At most one of 'id' or 'siteGroupId' can be specified. If 'siteGroupId' is specified, all conversion products belonging to this site group are retrieved. If 'siteId' is specified, all conversion products belonging to a site are retrieved. If neither 'id', 'siteGroupId' or 'siteId' are specified, all readable products for the user are retrieved.
Response
The response object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
Array of Object |
Array of conversion product objects . |
If 'id' was specified in the request, this array contains at most one element.
Examples
$ cx.py /conversion/product '{ "id": "777" }'
{
"products": [
{
"siteGroupId": "123",
"siteId": "444",
"id": "777",
"type": "subscription",
"name": "My first product",
"deleted": false
}
]
}
$ cx.py /conversion/product '{ "siteGroupId": "123" }'
{
"products": [
{
"siteGroupId": "123",
"siteId": "444",
"id": "777",
"type": "subscription",
"name": "My first product",
"deleted": false
},
{
"siteGroupId": "123",
"siteId": "444",
"id": "888",
"type": "newsletter",
"name": "My second product",
"deleted": false
}
]
}