Bloomreach

App · 25 actions

Manage Bloomreach Engagement customers, events, catalogs, analyses and imports.

Actions

ActionWhat it does
Anonymize customerAnonymize a customer.
Create catalogCreate a catalog.
Delete catalogDelete catalog.
Delete catalog itemDelete catalog item.
Export customer eventsExport events.
Get catalogGet catalog name.
Get catalog itemGet a catalog item.
Get consent categoriesGet consent categories.
Get customerExport a customer.
Get customer attributesCustomer attributes.
Get funnelRetrieve funnels.
Get importRead import.
Get reportRetrieve reports.
Get retentionRetrieve retentions.
Get segmentationRetrieve segmentations.
Get system timeSystem time.
List catalog itemsGet catalog items.
List catalogsGet all catalogs.
List importsList imports.
Patch catalog itemCatalog item - Partial update.
Rename catalogUpdate a catalog name.
Start importStart import.
Track eventAdd event.
Update catalog itemUpdate a catalog item.
Update customerUpdate customer properties.

Anonymize customer

Anonymize a customer.

Inputs

Customer IDscustomer_idsobjectRequired
Customer ids.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "success": false
  }
}

Create catalog

Create a catalog.

Inputs

NamenametextRequired
Name.
FieldsfieldslistRequired
Fields.
Is product catalogis_product_catalogtext
Is product catalog.Default: false.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "id": "example",
    "success": false
  }
}

Delete catalog

Delete catalog.

Inputs

Catalogcatalog_idtextRequired
Catalog id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "success": false
  }
}

Delete catalog item

Delete catalog item.

Inputs

Catalogcatalog_idtextRequired
Catalog id.
Item IDitem_idtextRequired
Item id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "queued": false,
    "success": false
  }
}

Export customer events

Export events.

Inputs

Event typesevent_typeslistRequired
The names of the events you want to export. Remember to grant Get permission for all listed events.
Orderordertext
Order by timestamp. `asc` for ascending (oldest to newest), `desc` for descending (newest to oldest). Default: `asc`.Default: asc.
Limitlimitnumber
The number of items to return. If not specified, all events are returned.Default: 3.
Skipskipnumber
The number of items to skip over. Default: `0`.Default: 10.
Customer IDscustomer_idsobjectRequired
Customer ids.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "success": false
  }
}

Get catalog

Get catalog name.

Inputs

Catalogcatalog_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

Catalogcatalog_idtextRequired
Catalog id.
Queryquerytext
Query.Default: Apple.
Fieldfieldtext
Field.Default: manufacturer.
Countcounttext
Count.Default: 50.
Skipskiptext
Skip.Default: 100.
Orderordertext
Order.Default: price%20desc,manufacturer%20asc.
Item IDitem_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.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "results": [],
    "success": false
  }
}

Get customer

Export a customer.

Inputs

Customer IDscustomer_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

AttributesattributeslistRequired
Attributes.
Customer IDscustomer_idsobjectRequired
Customer ids.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "results": [],
    "success": false
  }
}

Get funnel

Retrieve funnels.

Inputs

Analysis IDanalysis_idtextRequired
Analysis id.
Timezonetimezonetext
Timezone.Default: Europe/Bratislava.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "header": [],
    "name": "example",
    "rows": [],
    "success": false
  }
}

Get import

Read import.

Inputs

Import IDimport_idtextRequired
Import id.

Outputs

datalist
Returned value.
Example output
{
  "data": []
}

Get report

Retrieve reports.

Inputs

Analysis IDanalysis_idtextRequired
Analysis id.
Timezonetimezonetext
Timezone.Default: Europe/London.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "header": [],
    "name": "example",
    "rows": [],
    "success": false
  }
}

Get retention

Retrieve retentions.

Inputs

Analysis IDanalysis_idtextRequired
Analysis id.
Timezonetimezonetext
Timezone.Default: Europe/Bratislava.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "header": [],
    "name": "example",
    "rows": [],
    "success": false
  }
}

Get segmentation

Retrieve segmentations.

Inputs

Analysis IDanalysis_idtextRequired
Analysis id.
Timezonetimezonetext
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

Catalogcatalog_idtextRequired
Catalog id.
Queryquerytext
Query.Default: Apple.
Fieldfieldtext
Field.Default: manufacturer.
Countcounttext
Count.Default: 50.
Skipskiptext
Skip.Default: 100.
Orderordertext
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

Limitlimitnumber
`>= 1`, `<= 50`Default: 10.
Offsetoffsetnumber
Offset.Default: 0.

Outputs

datalist
Returned value.
Example output
{
  "data": []
}

Patch catalog item

Catalog item - Partial update.

Inputs

Catalogcatalog_idtextRequired
Catalog id.
Item IDitem_idtextRequired
Item id.
PropertiespropertiesobjectRequired
Properties.
Upsertupserttext
Upsert.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "queued": false,
    "success": false
  }
}

Rename catalog

Update a catalog name.

Inputs

Catalogcatalog_idtextRequired
Catalog id.
Namenametext
Name.Default: new catalog name.
Fieldsfieldslist
Fields.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "success": false
  }
}

Start import

Start import.

Inputs

Import IDimport_idtextRequired
Import id.
Pathpathtext
Path.Default: URL.
Test connectiontest_connectiontrue/false
Test connection.Default: true.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "success": false
  }
}

Track event

Add event.

Inputs

Timestamptimestampdate and time
Timestamp.Default: 1614941503.
Event typeevent_typetextRequired
Event type.
Customer IDscustomer_idsobjectRequired
Customer ids.
PropertiespropertiesobjectRequired
Properties.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "errors": [],
    "success": false
  }
}

Update catalog item

Update a catalog item.

Inputs

Catalogcatalog_idtextRequired
Catalog id.
Item IDitem_idtextRequired
Item id.
Propertiespropertiesobject
Properties.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "queued": false,
    "success": false
  }
}

Update customer

Update customer properties.

Inputs

Update timestampupdate_timestampdate and time
Update timestamp.Default: 1614941503.
Customer IDscustomer_idsobjectRequired
Customer ids.
PropertiespropertiesobjectRequired
Properties.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "errors": [],
    "success": false
  }
}

On this page