Feeds

Ubivox gives you easy access to your data using a variety of feeds in different formats. This information can be used for analyzing data in Excel or for integrating with external systems.

Supported formats

  • json - JSON encoded
  • csv - CSV encoded (separated by ;)

The format must be passed as the (format) parameter in the URL.

Other feed parameters

Some feeds require other parameters. These must be replaced in the URL before use. They are denoted by the (parameter) syntax below.

Base URL

You should use your Ubivox account URL as the base URL for all requests to the feeds.

Example

If the feeds documentation lists the following URL:

GET /feeds/delivery_link_used_by/(format)/delivery_id=(delivery_id)/link_id=(link_id)/

The actual URL for the JSON feed of delivery ID 283 and link ID 9454 will be:

https://account.clients.ubivox.com/feeds/delivery_link_used_by/json/delivery_id=283/link_id=9454/

Available feeds

archived feeds

GET /feeds/archived_deliveries/(format)/

Retrieves your archived deliveries.

Request Headers:
 
Status Codes:
GET /feeds/archived_deliveries_list/(format)/list_id=(list_id)/

Retrieves your archived deliveries for a given list.

Request Headers:
 
Status Codes:

client feeds

GET /feeds/client_statistics/(format)/

Retrieves some global statistics for your account.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:

contacts feeds

GET /feeds/contacts/(format)/

Contact count for your account

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:

course feeds

GET /feeds/course_data/(format)/list_id=(list_id)/stage_id=(stage_id)/period=(period)/

Retrieves statistical data about courses.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:

data feeds

GET /feeds/data_fields/(format)/

Retrieves data about your subscriber data fields.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:

deliveries feeds

GET /feeds/deliveries/(format)/

Retrieves data about your deliveries including some statistics.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:

delivery feeds

GET /feeds/delivery/(format)/delivery_id=(delivery_id)/

Retrieves information for a given delivery.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_bounce_rate_breakdown/(format)/delivery_id=(delivery_id)/

Retrieves a bounce rate breakdown in percent for a given delivery.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_bounces/(format)/delivery_id=(delivery_id)/

Retrieves a list of bounces for a given delivery.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_complaints/(format)/delivery_id=(delivery_id)/

Retrieves a list of complaints for a given delivery.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_devices/(format)/delivery_id=(delivery_id)/

Retrieves a list of opens per device for a given delivery.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_hour_interval_statistics/(format)/delivery_id=(delivery_id)/

Retrieves a list of hour intervals with view and click counts for a given delivery.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_link_used_by/(format)/delivery_id=(delivery_id)/link_id=(link_id)/

Retrieves a feed of the subscribers who has used a given link

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_links/(format)/delivery_id=(delivery_id)/

Retrieves a link summary for a delivery

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_locations_countries/(format)/delivery_id=(delivery_id)/

Retrieves a list of opens per country for a given delivery.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_locations_regions/(format)/delivery_id=(delivery_id)/country_code=(country_code)/

Retrieves a list of opens per region for a given country on a delivery.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_rates/(format)/delivery_id=(delivery_id)/

Retrieves view and click rate for a given delivery.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_reads/(format)/delivery_id=(delivery_id)/

Retrieves a list of recipients that had a read registered for a given delivery.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_recipients/(format)/delivery_id=(delivery_id)/

Retrieves a list of recipients for a given delivery.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_target_sales/(format)/delivery_id=(delivery_id)/target_id=(target_id)/

Retrieves a feed of the sales tracked by a given target for a given delivery

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_unsubscriptions/(format)/delivery_id=(delivery_id)/

Retrieves a list of unsubscription for a given delivery.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_view_link_statistics/(format)/delivery_id=(delivery_id)/

Retrieves view and link statistics for a given delivery. (10 days)

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/delivery_view_link_statistics_full/(format)/delivery_id=(delivery_id)/

Retrieves view and link statistics for a given delivery. (Full)

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:

email feeds

GET /feeds/email_hour/(format)/smtpuser_id=(smtpuser_id)/

Retrieves hourly usage for the last 90 days for transaction e-mails.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/email_month/(format)/smtpuser_id=(smtpuser_id)/

Retrieves usage per day for transaction e-mails.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/email_year/(format)/smtpuser_id=(smtpuser_id)/

Retrieves usage per month for transaction e-mails.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:

global feeds

GET /feeds/global_delivery_statistics/(format)/

Retrieves global statistics for your deliveries for your account.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/global_subscription_growth/(format)/

Retrieves global statistics for your subscription growth for your account.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:

list feeds

GET /feeds/list_deliveries/(format)/list_id=(list_id)/

Retrieves data about your deliveries for a given list including some statistics.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/list_hour_interval_statistics/(format)/list_id=(list_id)/

Retrieves data about your most active hours of the day.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/list_info/(format)/list_id=(list_id)/

Retrieves information about one of your lists.

Request Headers:
 
Status Codes:
GET /feeds/list_primary_data_fields/(format)/list_id=(list_id)/

Retrieves information about the primary, public data fields of one of your lists.

Request Headers:
 
Status Codes:
GET /feeds/list_signins/(format)/list_id=(list_id)/

Retrieves the last 10 signins to a given list.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/list_signouts/(format)/list_id=(list_id)/

Retrieves the last 10 signouts from a given list.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/list_subscription_growth/(format)/list_id=(list_id)/

Retrieves data about your subscription growth for a given list in the past 10 days.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/list_subscription_growth_180days/(format)/list_id=(list_id)/

Retrieves data about your subscription growth for a given list in the past 180 days.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/list_subscription_growth_30days/(format)/list_id=(list_id)/

Retrieves data about your subscription growth for a given list in the past 30 days.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/list_subscription_growth_365days/(format)/list_id=(list_id)/

Retrieves data about your subscription growth for a given list in the past 365 days.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/list_subscription_growth_730days/(format)/list_id=(list_id)/

Retrieves data about your subscription growth for a given list in the past 730 days.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/list_subscription_growth_90days/(format)/list_id=(list_id)/

Retrieves data about your subscription growth for a given list in the past 90 days.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/list_subscription_references/(format)/list_id=(list_id)/

Retrieves data about your subscription references.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:

lists feeds

GET /feeds/lists/(format)/

Retrieves data about your lists on Ubivox with title and subscription counts.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:

partner feeds

GET /feeds/partner_expiring_clients/(format)/

Retrieves a feed of expiring clients

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/partner_latest_deliveries/(format)/

Retrieves a feed of the latest deliveries

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/partner_latest_signups/(format)/

Retrieves a feed of the latest account signups

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes:
GET /feeds/partner_status/(format)/

Retrieves a status feed of new clients, sales etc.

Request Headers:
 
  • Authorization – Requires HTTP Basic authentication using the feeds credentials
Status Codes: