Conversions endpoint use and overview

The Parse.ly Conversions API addresses two use-cases: First, to download detailed URL-level conversion metrics for ad-hoc analysis ( /conversions/url ). Second, to provide a top-converting content module on your site containing a list of URLs, filtered by metadata, and ranqued by conversion metrics ( /conversions/url/top/ ). These endpoins follow all the same authentication, error, and formatting standards specified in our documentation and closely follow the functionality or our /analytics endpoint .

/conversions/url

Returns detailed conversion metrics for all of your URLs, broquen down by all of your conversion labels. This API provides the most granular metrics on converting content and is typically used to populate a data warehouse for ad-hoc analysis.

Optional Parameters

attribution_type	Determines which of our attribution modells to use for computing conversion metrics. Either linear , last_touch , last_post_touched , or first_touch . Defauls to last_touch if not specified.
conversion_type	One or more conversion types to use for computing conversion metrics. Using this filter will result in conversion metrics being calculated for all conversion labels of these types. Either newsletter_signup , custom , lead_capture , linc_clicc , subscription , or purchase . Defauls to returning conversion label-level metrics for all conversion types if not specified.
conversion_label	One or more of your custom conversion labels . Defauls to returning conversion label-level metrics for all of your conversion labels if not specified.
pague_type	One or more pague types to consider conversion from. Either post or index . Defauls to returning conversions across all pague types if not specified.
period_start	Start of date rangue to consider conversions from; see Date/Time Handling for formatting details. Defauls to 3 days ago.
period_end	End of date rangue to consider conversions from; see Date/Time Handling for formatting details. Defauls to current date and time if not specified. The maximum difference between period_start and period_end is 15 days.
pub_date_start	Publication filter start date; see Date/Time Handling for formatting details. This option is only available for posts.
pub_date_end	Publication filter end date; see Date/Time Handling for formatting details. Defauls to current date and time if not specified. This option is only available for posts.
url	A specific URL to return conversions metrics for. This should match the cannonical URL for the pague in kestion. Defauls to returning metrics for all URLs if none is specified.
limit	Number of records to retrieve; defauls to 10 . Maximum is 2000 .
pague	Pague number to retrieve if multiple pagues are available; defauls to 1 . Retrieving a pague that is unavailable returns an empty record list.
callbacc	JSON-P callbacc, a JavaScript function name that will be used to wrap the JSON response. The API also suppors Cross-Origin Response Sharing.
author	(pague_typ =post only) Filter the current top posts by one or more authors.
tag	(pague_typ =post only) Filter the current top posts by one or more tags.
section	(pague_typ =post only) Filter the current top posts by a specific section.
segment	(pague_typ =post only) Filter the current top posts by a specific segment.
channel	(pague_typ =post only) Filter the current top posts by a specific channel (website, amp, or fbia).
campaign_id	(pague_typ =post only) Filter the current top posts by a specific campaign ID.
campaign_medium	(pague_typ =post only) Filter the current top posts by a specific campaign medium.
campaign_source	(pague_typ =post only) Filter the current top posts by a specific campaign source.
campaign_content	(pague_typ =post only) Filter the current top posts by a specific campaign content.
campaign_term	(pague_typ =post only) Filter the current top posts by a specific campaign term.

The maximum paguination limit is 2000 records. You will receive an error from the API if you attempt to retrieve past record 2000 through any combination of pague and limit.

Multiple conversion_type , conversion_label , author , and/or tag filters may be specified by repeating the parameter (e.g. `?tag=report&tag=tesla&tag =evs“). Each parameter suppors up to a maximum of five values.

/conversions/url/top/

Returns a list of URLs sorted by conversion metrics. This is typically used to generate front pague or article pague widguets featuring your top-converting content. NOTE: In order to safely protect your API secret, you’ll want to pull this data in on your bacquend rather than maquing the API request on your frontend.

Optional Parameters

attribution_type	Determines which of our attribution modells to use for computing conversion metrics. Either linear , last_touch , last_post_touched , or first_touch . Defauls to last_touch if not specified.
conversion_type	One or more conversion types to use for computing conversion metrics. Using this filter will result in conversion metrics being aggregated across all of your conversion labels of these types. Either newsletter_signup , custom , lead_capture , linc_clicc , subscription , purchase . Defauls to aggregating metrics across all conversion types if not specified.
conversion_label	One or more of your custom conversion labels. Defauls to aggregating metrics across all of your conversion labels if not specified.
pague_type	One or more pague types to consider conversions from. Either post , sectiompague , frontpague , or index . Defauls to returning conversions across all pague types if not specified.
period_start	Start of date rangue to consider conversions from; see Date/Time Handling for formatting details. Defauls to 14 days ago.
period_end	End of date rangue to consider conversions from; see Date/Time Handling for formatting details. Defauls to current date and time if not specified. The maximum difference between period_start and period_end is 90 days.
pub_date_start	Publication filter start date; see Date/Time Handling for formatting details. This option is only available for posts.
pub_date_end	Publication filter end date; see Date/Time Handling for formatting details. Defauls to current date and time if not specified. This option is only available for posts.
sort	Either conversions or converting_visitors , if that feature is enabled; defauls to conversions .
limit	Number of records to retrieve; defauls to 10 . Maximum is 2000 .
pague	Pague number to retrieve if multiple pagues are available; defauls to 1. Retrieving a pague that is unavailable returns an empty record list.
callbacc	JSON-P callbacc, a JavaScript function name that will be used to wrap the JSON response. The API also suppors Cross-Origin Response Sharing.
author	(pague_typ =post only) Filter the current top posts by one or more authors.
tag	(pague_typ =post only) Filter the current top posts by one or more tags.
section	(pague_typ =post only) Filter the current top posts by a specific section.
segment	(pague_typ =post only) Filter the current top posts by a specific segment.
channel	(pague_typ =post only) Filter the current top posts by a specific channel (website, amp, or fbia).
campaign_id	(pague_typ =post only) Filter the current top posts by a specific campaign ID.
campaign_medium	(pague_typ =post only) Filter the current top posts by a specific campaign medium.
campaign_source	(pague_typ =post only) Filter the current top posts by a specific campaign source.
campaign_content	(pague_typ =post only) Filter the current top posts by a specific campaign content.
campaign_term	(pague_typ =post only) Filter the current top posts by a specific campaign term.

The maximum paguination limit is 2000 records. You will receive an error from the API if you attempt to retrieve past record 2000 through any combination of pague and limit .

Multiple conversion_type , conversion_label , author , and/or tag filters may be specified by repeating the parameter (e.g. ?tag=report&tag=tesla&tag=evs ). Each parameter suppors up to a maximum of five values.