# Bloomreach

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/bloomreach

## Actions

### Anonymize customer

Anonymize a customer.

**Inputs**

- Customer IDs (`customer_ids`, object, required): Customer ids.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "success": false
  }
}
```

### Create catalog

Create a catalog.

**Inputs**

- Name (`name`, text, required): Name.
- Fields (`fields`, list, required): Fields.
- Is product catalog (`is_product_catalog`, text): Is product catalog. Default: `false`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "id": "example",
    "success": false
  }
}
```

### Delete catalog

Delete catalog.

**Inputs**

- Catalog (`catalog_id`, text, required): Catalog id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "success": false
  }
}
```

### Delete catalog item

Delete catalog item.

**Inputs**

- Catalog (`catalog_id`, text, required): Catalog id.
- Item ID (`item_id`, text, required): Item id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "queued": false,
    "success": false
  }
}
```

### Export customer events

Export events.

**Inputs**

- Event types (`event_types`, list, required): The names of the events you want to export. Remember to grant Get permission for all listed events.
- Order (`order`, text): Order by timestamp. `asc` for ascending (oldest to newest), `desc` for descending (newest to oldest). Default: `asc`. Default: `asc`.
- Limit (`limit`, number): The number of items to return. If not specified, all events are returned. Default: `3`.
- Skip (`skip`, number): The number of items to skip over. Default: `0`. Default: `10`.
- Customer IDs (`customer_ids`, object, required): Customer ids.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "success": false
  }
}
```

### Get catalog

Get catalog name.

**Inputs**

- Catalog (`catalog_id`, text, required): Catalog id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "id": "example",
      "name": "example"
    },
    "success": false
  }
}
```

### Get catalog item

Get a catalog item.

**Inputs**

- Catalog (`catalog_id`, text, required): Catalog id.
- Query (`query`, text): Query. Default: `Apple`.
- Field (`field`, text): Field. Default: `manufacturer`.
- Count (`count`, text): Count. Default: `50`.
- Skip (`skip`, text): Skip. Default: `100`.
- Order (`order`, text): Order. Default: `price%20desc,manufacturer%20asc`.
- Item ID (`item_id`, text, required): Item id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "limit": 1,
    "matched": 1,
    "matched_limited": false,
    "skip": 1,
    "success": false,
    "total": 1
  }
}
```

### Get consent categories

Get consent categories.

**Inputs**: None.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "results": [],
    "success": false
  }
}
```

### Get customer

Export a customer.

**Inputs**

- Customer IDs (`customer_ids`, object, required): Customer ids.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "events": [],
    "ids": {
      "cookie": [],
      "registered": []
    },
    "properties": {
      "email": "example",
      "first_name": "example",
      "last_name": "example"
    },
    "success": false
  }
}
```

### Get customer attributes

Customer attributes.

**Inputs**

- Attributes (`attributes`, list, required): Attributes.
- Customer IDs (`customer_ids`, object, required): Customer ids.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "results": [],
    "success": false
  }
}
```

### Get funnel

Retrieve funnels.

**Inputs**

- Analysis ID (`analysis_id`, text, required): Analysis id.
- Timezone (`timezone`, text): Timezone. Default: `Europe/Bratislava`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "header": [],
    "name": "example",
    "rows": [],
    "success": false
  }
}
```

### Get import

Read import.

**Inputs**

- Import ID (`import_id`, text, required): Import id.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Get report

Retrieve reports.

**Inputs**

- Analysis ID (`analysis_id`, text, required): Analysis id.
- Timezone (`timezone`, text): Timezone. Default: `Europe/London`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "header": [],
    "name": "example",
    "rows": [],
    "success": false
  }
}
```

### Get retention

Retrieve retentions.

**Inputs**

- Analysis ID (`analysis_id`, text, required): Analysis id.
- Timezone (`timezone`, text): Timezone. Default: `Europe/Bratislava`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "header": [],
    "name": "example",
    "rows": [],
    "success": false
  }
}
```

### Get segmentation

Retrieve segmentations.

**Inputs**

- Analysis ID (`analysis_id`, text, required): Analysis id.
- Timezone (`timezone`, text): Timezone. Default: `Europe/London`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "header": [],
    "name": "example",
    "rows": [],
    "success": false
  }
}
```

### Get system time

System time.

**Inputs**: None.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "errors": [],
    "success": false,
    "time": 1
  }
}
```

### List catalog items

Get catalog items.

**Inputs**

- Catalog (`catalog_id`, text, required): Catalog id.
- Query (`query`, text): Query. Default: `Apple`.
- Field (`field`, text): Field. Default: `manufacturer`.
- Count (`count`, text): Count. Default: `50`.
- Skip (`skip`, text): Skip. Default: `100`.
- Order (`order`, text): Order. Default: `price%20desc,manufacturer%20asc`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "limit": 1,
    "matched": 1,
    "matched_limited": false,
    "skip": 1,
    "success": false,
    "total": 1
  }
}
```

### List catalogs

Get all catalogs.

**Inputs**: None.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "success": false
  }
}
```

### List imports

List imports.

**Inputs**

- Limit (`limit`, number): `>= 1`, `<= 50`. Default: `10`.
- Offset (`offset`, number): Offset. Default: `0`.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Patch catalog item

Catalog item - Partial update.

**Inputs**

- Catalog (`catalog_id`, text, required): Catalog id.
- Item ID (`item_id`, text, required): Item id.
- Properties (`properties`, object, required): Properties.
- Upsert (`upsert`, text): Upsert.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "queued": false,
    "success": false
  }
}
```

### Rename catalog

Update a catalog name.

**Inputs**

- Catalog (`catalog_id`, text, required): Catalog id.
- Name (`name`, text): Name. Default: `new catalog name`.
- Fields (`fields`, list): Fields.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "success": false
  }
}
```

### Start import

Start import.

**Inputs**

- Import ID (`import_id`, text, required): Import id.
- Path (`path`, text): Path. Default: `URL`.
- Test connection (`test_connection`, true/false): Test connection. Default: `true`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "success": false
  }
}
```

### Track event

Add event.

**Inputs**

- Timestamp (`timestamp`, date and time): Timestamp. Default: `1614941503`.
- Event type (`event_type`, text, required): Event type.
- Customer IDs (`customer_ids`, object, required): Customer ids.
- Properties (`properties`, object, required): Properties.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "errors": [],
    "success": false
  }
}
```

### Update catalog item

Update a catalog item.

**Inputs**

- Catalog (`catalog_id`, text, required): Catalog id.
- Item ID (`item_id`, text, required): Item id.
- Properties (`properties`, object): Properties.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "queued": false,
    "success": false
  }
}
```

### Update customer

Update customer properties.

**Inputs**

- Update timestamp (`update_timestamp`, date and time): Update timestamp. Default: `1614941503`.
- Customer IDs (`customer_ids`, object, required): Customer ids.
- Properties (`properties`, object, required): Properties.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "errors": [],
    "success": false
  }
}
```
