# Niftyimages

Allowing marketers to create dynamic and personalized content for your email campaigns.

- **Category:** marketing automation
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `NIFTYIMAGES`
- **Version:** 00000000_00

## Tools

### Get Images Stats

**Slug:** `NIFTYIMAGES_GET_IMAGES_STATS`

Tool to get aggregated stats for all images. Use when you need to retrieve statistical data and performance metrics for all images in the account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Widget User Images

**Slug:** `NIFTYIMAGES_GET_WIDGET_USER_IMAGES`

Tool to list widget images for a specific user. Use when you need to retrieve all images associated with a particular user and widget combination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | string | Yes | The user identifier to retrieve images for. |
| `widget_key` | string | Yes | The unique identifier (key) of the widget. This is a UUID format identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Widget User Stats

**Slug:** `NIFTYIMAGES_GET_WIDGET_USER_STATS`

Tool to get aggregated stats for a specific user on a widget. Use when you need to retrieve performance metrics for a particular user's interaction with a widget.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | string | Yes | The user identifier for which to retrieve aggregated stats |
| `widget_key` | string | Yes | The unique identifier (key) of the widget |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Images

**Slug:** `NIFTYIMAGES_LIST_IMAGES`

Tool to page through images in your NiftyImages account. Use when you need to retrieve a list of all available images.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Maps

**Slug:** `NIFTYIMAGES_LIST_MAPS`

Tool to retrieve all maps in your NiftyImages account. Use when you need to view all available maps for geo-targeting or location-based email content.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Widget Images

**Slug:** `NIFTYIMAGES_LIST_WIDGET_IMAGES`

Tool to list widget images for a time frame. Use when you need to retrieve images generated by a specific widget within an optional date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | No | End date in ISO 8601 format (e.g., 2024-12-31T23:59:59Z). Filter images created on or before this date. |
| `start_date` | string | No | Start date in ISO 8601 format (e.g., 2024-01-01T00:00:00Z). Filter images created on or after this date. |
| `widget_key` | string | Yes | The unique identifier (key) of the widget. This is a UUID format identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Widgets

**Slug:** `NIFTYIMAGES_LIST_WIDGETS`

Tool to list all widgets in your NiftyImages account. Use when you need to retrieve all available widgets.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List widget stats

**Slug:** `NIFTYIMAGES_LIST_WIDGET_STATS`

Tool to retrieve widget statistics for a specified time frame from NiftyImages. Use when you need to view performance metrics such as impressions and clicks for your widgets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `endDate` | string | No | End date for the stats time frame in ISO 8601 format (e.g., 2016-03-10T08:00Z). If not provided, stats up to the current time will be included. |
| `startDate` | string | No | Start date for the stats time frame in ISO 8601 format (e.g., 2016-02-10T08:00Z). If not provided, stats from the beginning will be included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Widget Users

**Slug:** `NIFTYIMAGES_LIST_WIDGET_USERS`

Tool to list widget users for a specified time frame from NiftyImages. Use when you need to retrieve users who interacted with a specific widget during a date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `endDate` | string | No | End date for the time frame in ISO 8601 format (e.g., 2026-02-13T23:59:59Z). If not specified, defaults to API's default end date. |
| `startDate` | string | No | Start date for the time frame in ISO 8601 format (e.g., 2026-01-01T00:00:00Z). If not specified, defaults to API's default start date. |
| `widgetKey` | string | Yes | The unique identifier (key) of the widget to retrieve users for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |