Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 2 Next »

Platform URL

https://[enterprise].cvtr.io/v2/….

API Endpoints

GET /api/v4/

…..

Epic

Document status

DRAFT

Document owner

Danny Hannah Adam Carter

Technical writers

Related Content

🏠 Feature Overview

Scheduled Delivery can be enabled for a campaign if the leads need to be scheduled to be delivered at different times and at different intervals. The schedule widget is used to configure the delivery time and intervals.

Scheduled delivery can be either ‘Campaign’ based on ‘Publisher’ based. The type of Scheduled Delivery can be set by selecting the corresponding radio button available against ‘Type’ on the Scheduled Delivery page:

Screenshot 2024-04-10 at 14.30.43.png

In this document, we will discuss the working of ‘Campaign’ type Scheduled delivery.

Campaign based Scheduled Delivery

When the ‘Type' of Scheduled delivery is set to 'Campaign’, the schedule configuration will apply to all the leads from all publishers on the campaign.

When the type selected is Campaign, the configuration screen looks as below, if publisher bands are not enabled on the campaign.

Screenshot 2024-04-17 at 14.35.26.png

When the type selected is Campaign, the configuration screen looks as below, if publisher bands are enabled on the campaign.

Screenshot 2024-04-17 at 15.01.02.png

The ‘Band Level’ toggle under Max Cap is visible only when publisher bands are enabled for the campaign.

It can be seen that ‘Add Publisher(s)’ ‘View Schedules’ and ‘Save’ buttons are disabled.

Since the type selected is ‘Campaign’, the schedule applies to all publishers on the campaign. Hence, ‘Add Publisher(s)’ button will remain disabled for this type of scheduled delivery.

‘Save’ button will be enabled only when all the mandatory fields have been entered.

‘View Schedules’ button will be enabled once the schedule details are entered and Save button is clicked.

The table below describes each column in the scheduled delivery configuration page.

Field

Description

Publisher

This column refers to the publishers for which the schedule must apply. In the case of campaign based Scheduled delivery, the schedule applies to ‘All Publishers’ by default and this cannot be changed.

Max Cap

  • When publisher bands are not enabled on the campaign, Max Cap refers to the maximum number of leads that can be held by scheduled delivery in a single schedule.

In the below case, a maximum of 10 valid leads will be held by the schedulr until it is delivered at the schedule time.

Screenshot 2024-04-17 at 15.21.08.png
  • When publisher bands are enabled on the campaign, Max Cap can be set as the maximum number of leads that can be held either for the entire schedule or for the selected band by toggling the ‘Band Level’ toggle off or on respectively.

Screenshot 2024-04-17 at 15.22.41.png
  • When publisher bands are enabled, the ‘Band Level’ toggle under ‘Max Cap’ can be enabled to see the available bands and a max cap can be set for each band.

Screenshot 2024-04-17 at 15.14.26.png

The below configuration for Max Cap would mean that a maximum of 5 leads can be delivered for the band ‘UK’ and a maximum of 10 leads can be delivered for the band ‘US’ in a single schedule of scheduled delivery. Since the max cap for the ‘Default’ band is set to 0, default leads (leads that do not fall into any of the configured publisher bands) will not be scheduled for delivery.

Screenshot 2024-04-17 at 15.15.55.png
  • Even if publisher bands are available on the campaign, the user can choose to configure the Max Cap for the entire set of leads and not at band level, by keeping the ‘Band Level' toggle disabled.

In the below scenario, we know that the campaign has publisher bands enabled because the ‘Band Level’ toggle is available under Max Cap. However, since the toggle is disabled, the max cap configured applies to the entire set of leads irrespective of the bands they fall into.

Screenshot 2024-04-17 at 15.24.50.png

Therefore valid leads that fall into bands as well as valid default leads will be considered and scheduled for delivery.

Schedule

This is the actual configuration that determines the delivery interval of leads. Working of the schedule configuration widget is explained here

Next Schedule

This column shows when the next schedule (date and time) will run to deliver leads. The schedule details are shown in the Enterprise timezone. This is also evident from the column heading which shows the timezone with respect to GMT.

View Schedules

This button is enabled once the scheduled delivery configuration is saved.

The user can see the ‘Pending Schedule’ showing the leads that are pending to be sent in the upcoming schedule.

The user can also see any leads that were already delivered by the scheduled delivery by clicking on the ‘Sent Schedule’ option.

More details about Pending and Sent schedules is available here

Examples of Campaign based Scheduled Delivery Configurations

  1. Max Cap is configured for entire schedule. Schedule runs at 10 a.m. every Thursday from 14 Feb 2024 till the end of the campaign. The next schedule will run at 10 a.m. on 18th April 2024.

Screenshot 2024-04-17 at 15.32.25.png
  1. Max Cap is configured at Band level.

10 default leads, 20 leads each, falling into UK band and US band will be delivered at 19hrs on 30th April 2024. The schedule will repeat on the last day of every month until the campaign ends.

Screenshot 2024-04-17 at 15.34.28.png

\uD83D\uDDD2 Summary

Functionality

User Story

1

Campaign type Scheduled Delivery

Admin and Agency users can configure scheduled delivery at the campaign level so that the schedule is applied to all the publishers on the campaign

2

Max Cap configurable at band level

Admin and Agency users can configure Max Cap to be applied at the band level so that the leads may be delivered as per individual band requirements across all publishers.

\uD83D\uDDD2 User Permissions

Only Admin and Agency users have access to Scheduled Delivery.

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=415459484

  • No labels