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 Current »

Platform URL

https://[enterprise].cvtr.io/v2/campaigns/{campaignId}/admin/scheduled-delivery

API Endpoints

Retrieve all schedules configured on the campaign

GET /api/v4/scheduled-deliveries?page=1&itemsPerPage=50&campaign.id={campaignId}

Enable/Disable Scheduled Delivery toggle

PUT /api/v4/campaigns/{campaignId}

Update schedule configuration

PUT /api/v4/scheduled-deliveries/{scheduleId}

Epic

CON-5548 - Getting issue details... STATUS

Document status

READY FOR REVIEW

Document owner

Danny Hannah Adam Carter

Technical writers

Arunima Kurup Prasad

Related Content

Scheduled Delivery Overview Schedule Configuration https://convertr.atlassian.net/wiki/spaces/PF/pages/edit-v2/3242459137

🏠 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 ‘Publisher’ type Scheduled delivery.

Publisher based Scheduled Delivery

When the ‘Type' of Scheduled delivery is set to 'Publisher’, the user can configure different schedules for the different publishers assigned to the campaign.

When the type selected is Publisher, the configuration screen initially looks like below.

Screenshot 2024-04-17 at 15.53.35.png

There is no data available in the table and the ‘Save’ button is disabled.

The 'Add Publisher(s)’ button is enabled by default and the user has to use it to manually add the publishers and configure the schedule separately for each of the publishers.

Documentation on Adding publishers can be found here.

Once the publishers are added and the schedule for the individual publishers is configured, the page looks like below.

Screenshot 2024-04-17 at 16.27.17.png

In the above case, scheduled delivery is configured for the publishers that are active on the campaign.

For publishers ‘Turtlentertainment’ and ‘Ocean Softwares’, the schedule is configured to be delivered at publisher band level whereas for ‘Blue whale’ the cap is configured for the set of leads irrespective of the publisher bands.

In the case of ‘Turtlentertainment’, a maximum of 10 valid leads falling in the US band and a maximum of 10 valid leads falling in the UK band will be held and delivered on the 19th of April at 10hrs. Default leads will not be delivered as the cap for Default is set to 0.

The delivery will be repeated every Monday, Wednesday and Friday starting from the 17th of April till the end of the campaign.

Similarly for 'Ocean Softwares’, a maximum of 5 valid leads falling in the US band, a maximum of 5 valid leads falling in the UK band and a maximum of 2 valid leads that do not fall in either of the bands will be held and delivered on the 18th of April at 9hrs. The delivery will be repeated daily starting from the 16th of April till the end of the campaign.

A maximum of 20 valid leads by ‘Blue Whale’ publisher will be held and delivered irrespective of the bands they fall into, at 8hrs on the 1st of May 2024. The schedule will be repeated on the first of every month excluding weekends, starting from the 17th of April till the end of the campaign.

Schedule can be configured to start on different dates for the different publishers.

Schedule can be configured at band level for some and not all publishers, if required.

Schedule can be configured for different intervals (monthly/weekly/daily) and different delivery times for the different publishers.

‘Next Schedule’ can be different for each of the publishers based on schedule configuration, i.e. leads from different publishers can be delivered on different days/time/intervals.

Unlike Campaign based Scheduled Delivery, we can see that the Actions column has separate ‘View Schedules’ button for each of the publisher. This is because, each publisher has a distinct schedule configured. We can track the leads pending delivery and the leads sent out per publisher by looking at the ‘Pending Schedule’ and ‘Sent Schedule’ tab for each of the publishers separately.

Screenshot 2024-04-17 at 17.29.49.png

\uD83D\uDDD2 Summary

Functionality

User Story

1

Publisher type Scheduled Delivery

Admin and Agency users can configure different schedules for different publishers on the campaign so that leads from the various publishers are not delivered at once and are staggered.

\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