/
Batch Management

Batch Management

 

Platform URL

https://[enterprise].cvtr.io/v2/system/campaign-lead-batch/pending-batch

https://[enterprise].cvtr.io/v2/system/campaign-lead-batch/sent-batches

 

API Endpoints

Retrieves the Batch Integration:

GET/OPTIONS https://{enterprise}.cvtr.io/api/v4/batch-manager

Retrieves a Campaign Lead Batches:

GET https://{enterprise}.cvtr.io/api/v4/campaign-lead-batches

Batches leads and Removes leads from the list:

POST/OPTIONS https://{enterprise}.cvtr.io/api/v4/batch-manager-batch-now

Downloads the list of sent leads:

Epic

https://convertr.atlassian.net/browse/CON-4952

Document status

DRAFT

Document owner

@Adam Carter

Technical writers

 

Feature Overview

Here users can see any leads that are currently Pending or have been Sent using the Batch CSV integration. Users have the option to download any previous send or users can override when the file should be sent by using batch now.

Pending Batches

Shows any batch CSV integrations that are pending to be sent

Column Name

Description

Column Name

Description

Advertiser ID

The advertiser ID

Advertiser Name

The advertiser name

Campaign ID

The campaign id

Campaign Name

The campaign name

Label

The label name of the Batch CSV integration

Lead

Number of leads in the file

Schedule

The batch CSV Integration Schedule

Campaign End Date

The date of when the campaign will end

 

Pending View

Show the leads that are currently in the file to be sent

Sent Batches

Shows any batch CSV integrations that have already been sent

Column Name

Description

Column Name

Description

ID

Uniquie File ID (used in DB)

Advertiser ID

The advertiser ID

Advertiser Name

The advertiser name

Campaign ID

The campaign id

Campaign Name

The campaign name

Label

The label name of the Batch CSV integration

Lead

Number of leads in the file

Sent

The date of when the file was sent

Sent View

Show the leads that have been sent

Requirements

Requirement

User Story

Notes

Requirement

User Story

Notes

1

Pending Batches

Users can see the table listing of all the files ready to be sent

 

2

Pending Batches > Configure

Redirects the user to the batch CSV integration config

 

3

Pending Batches > View

Allows the user to which leads are queued to be sent

 

4

Pending Batches > Batch now

Allows the user to override the schedule and push the file through immediately

 

5

Sent Batches

Users can see the table listing of all the files that have been sent

 

6

Sent Batches > View

Allows the user to which leads have been sent

 

7

Sent Batches > Download

Users can download the file that have been sent

 

8

Table Filtering

Allows the user to filer the table values using Advertiser Id, Advertiser Name, Campaign Id, Campaign Name and Label

 

9

Custom Tables

A user can add, remove and reset columns for custom table

 

User interaction and design

Open Questions

Question

Answer

Date Answered

Question

Answer

Date Answered

 

Out of Scope

Related content

Campaign Listing
Campaign Listing
More like this
Validation Lists
Validation Lists
Read with this
Batch Management
Batch Management
More like this
System Audit
System Audit
Read with this
Scheduled Delivery Overview
Scheduled Delivery Overview
More like this
Credential Manager
Credential Manager
Read with this