Bloomreach
App · 25 actions
Manage Bloomreach Engagement customers, events, catalogs, analyses and imports.
Actions
| Action | What it does |
|---|---|
| Anonymize customer | Anonymize a customer. |
| Create catalog | Create a catalog. |
| Delete catalog | Delete catalog. |
| Delete catalog item | Delete catalog item. |
| Export customer events | Export events. |
| Get catalog | Get catalog name. |
| Get catalog item | Get a catalog item. |
| Get consent categories | Get consent categories. |
| Get customer | Export a customer. |
| Get customer attributes | Customer attributes. |
| Get funnel | Retrieve funnels. |
| Get import | Read import. |
| Get report | Retrieve reports. |
| Get retention | Retrieve retentions. |
| Get segmentation | Retrieve segmentations. |
| Get system time | System time. |
| List catalog items | Get catalog items. |
| List catalogs | Get all catalogs. |
| List imports | List imports. |
| Patch catalog item | Catalog item - Partial update. |
| Rename catalog | Update a catalog name. |
| Start import | Start import. |
| Track event | Add event. |
| Update catalog item | Update a catalog item. |
| Update customer | Update customer properties. |
Anonymize customer
Anonymize a customer.
Inputs
- Customer IDs
customer_idsobjectRequired - Customer ids.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"success": false
}
}Create catalog
Create a catalog.
Inputs
- Name
nametextRequired - Name.
- Fields
fieldslistRequired - Fields.
- Is product catalog
is_product_catalogtext - Is product catalog.Default:
false.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"id": "example",
"success": false
}
}Delete catalog
Delete catalog.
Inputs
- Catalog
catalog_idtextRequired - Catalog id.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"success": false
}
}Delete catalog item
Delete catalog item.
Inputs
- Catalog
catalog_idtextRequired - Catalog id.
- Item ID
item_idtextRequired - Item id.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"queued": false,
"success": false
}
}Export customer events
Export events.
Inputs
- Event types
event_typeslistRequired - The names of the events you want to export. Remember to grant Get permission for all listed events.
- Order
ordertext - Order by timestamp. `asc` for ascending (oldest to newest), `desc` for descending (newest to oldest). Default: `asc`.Default:
asc. - Limit
limitnumber - The number of items to return. If not specified, all events are returned.Default:
3. - Skip
skipnumber - The number of items to skip over. Default: `0`.Default:
10. - Customer IDs
customer_idsobjectRequired - Customer ids.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": [],
"success": false
}
}Get catalog
Get catalog name.
Inputs
- Catalog
catalog_idtextRequired - Catalog id.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": {
"id": "example",
"name": "example"
},
"success": false
}
}Get catalog item
Get a catalog item.
Inputs
- Catalog
catalog_idtextRequired - Catalog id.
- Query
querytext - Query.Default:
Apple. - Field
fieldtext - Field.Default:
manufacturer. - Count
counttext - Count.Default:
50. - Skip
skiptext - Skip.Default:
100. - Order
ordertext - Order.Default:
price%20desc,manufacturer%20asc. - Item ID
item_idtextRequired - Item id.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": [],
"limit": 1,
"matched": 1,
"matched_limited": false,
"skip": 1,
"success": false,
"total": 1
}
}Get consent categories
Get consent categories.
Inputs
None.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"results": [],
"success": false
}
}Get customer
Export a customer.
Inputs
- Customer IDs
customer_idsobjectRequired - Customer ids.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"events": [],
"ids": {
"cookie": [],
"registered": []
},
"properties": {
"email": "example",
"first_name": "example",
"last_name": "example"
},
"success": false
}
}Get customer attributes
Customer attributes.
Inputs
- Attributes
attributeslistRequired - Attributes.
- Customer IDs
customer_idsobjectRequired - Customer ids.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"results": [],
"success": false
}
}Get funnel
Retrieve funnels.
Inputs
- Analysis ID
analysis_idtextRequired - Analysis id.
- Timezone
timezonetext - Timezone.Default:
Europe/Bratislava.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"header": [],
"name": "example",
"rows": [],
"success": false
}
}Get import
Read import.
Inputs
- Import ID
import_idtextRequired - Import id.
Outputs
datalist- Returned value.
Example output
{
"data": []
}Get report
Retrieve reports.
Inputs
- Analysis ID
analysis_idtextRequired - Analysis id.
- Timezone
timezonetext - Timezone.Default:
Europe/London.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"header": [],
"name": "example",
"rows": [],
"success": false
}
}Get retention
Retrieve retentions.
Inputs
- Analysis ID
analysis_idtextRequired - Analysis id.
- Timezone
timezonetext - Timezone.Default:
Europe/Bratislava.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"header": [],
"name": "example",
"rows": [],
"success": false
}
}Get segmentation
Retrieve segmentations.
Inputs
- Analysis ID
analysis_idtextRequired - Analysis id.
- Timezone
timezonetext - Timezone.Default:
Europe/London.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"header": [],
"name": "example",
"rows": [],
"success": false
}
}Get system time
System time.
Inputs
None.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"errors": [],
"success": false,
"time": 1
}
}List catalog items
Get catalog items.
Inputs
- Catalog
catalog_idtextRequired - Catalog id.
- Query
querytext - Query.Default:
Apple. - Field
fieldtext - Field.Default:
manufacturer. - Count
counttext - Count.Default:
50. - Skip
skiptext - Skip.Default:
100. - Order
ordertext - Order.Default:
price%20desc,manufacturer%20asc.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": [],
"limit": 1,
"matched": 1,
"matched_limited": false,
"skip": 1,
"success": false,
"total": 1
}
}List catalogs
Get all catalogs.
Inputs
None.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": [],
"success": false
}
}List imports
List imports.
Inputs
- Limit
limitnumber - `>= 1`, `<= 50`Default:
10. - Offset
offsetnumber - Offset.Default:
0.
Outputs
datalist- Returned value.
Example output
{
"data": []
}Patch catalog item
Catalog item - Partial update.
Inputs
- Catalog
catalog_idtextRequired - Catalog id.
- Item ID
item_idtextRequired - Item id.
- Properties
propertiesobjectRequired - Properties.
- Upsert
upserttext - Upsert.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"queued": false,
"success": false
}
}Rename catalog
Update a catalog name.
Inputs
- Catalog
catalog_idtextRequired - Catalog id.
- Name
nametext - Name.Default:
new catalog name. - Fields
fieldslist - Fields.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"success": false
}
}Start import
Start import.
Inputs
- Import ID
import_idtextRequired - Import id.
- Path
pathtext - Path.Default:
URL. - Test connection
test_connectiontrue/false - Test connection.Default:
true.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"success": false
}
}Track event
Add event.
Inputs
- Timestamp
timestampdate and time - Timestamp.Default:
1614941503. - Event type
event_typetextRequired - Event type.
- Customer IDs
customer_idsobjectRequired - Customer ids.
- Properties
propertiesobjectRequired - Properties.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"errors": [],
"success": false
}
}Update catalog item
Update a catalog item.
Inputs
- Catalog
catalog_idtextRequired - Catalog id.
- Item ID
item_idtextRequired - Item id.
- Properties
propertiesobject - Properties.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"queued": false,
"success": false
}
}Update customer
Update customer properties.
Inputs
- Update timestamp
update_timestampdate and time - Update timestamp.Default:
1614941503. - Customer IDs
customer_idsobjectRequired - Customer ids.
- Properties
propertiesobjectRequired - Properties.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"errors": [],
"success": false
}
}