RingRevenue::findAll | TUNE Dev Hub

Jump to: GET Response Notes | API Call Builder

Find Ring Revenue transactions.

= Required Parameter

Name

Type

Description

fields

Array

List of fields to return; defaults to all fieldsShow Supported Values

Any of the following values from the RingRevenue model are supported.

Name	Description
added_to_conversions	Whether or not the Invoca transaction has been recorded as a HasOffers conversion
advertiser_call_fee_localized	Advertiser Telecommunications fee associated with transaction
advertiser_campaign_id	id of Invoca objectentifier of the campaign
advertiser_campaign_id_from_network	ID of Campaign object from the network as set on the advertiser campaign
advertiser_id	id of Invoca objectentifier of the advertiser
advertiser_id_from_network	ID of Advertiser object from the network as set on the Invoca advertiser
advertiser_payin_localized	Amount paid in by advertiser
affiliate_call_volume_ranking	Network ranking of affiliate's call volume (0 to 5, and -1 being 'new'). Blank if no affiliate.
affiliate_commissions_ranking	Network ranking of affiliate's commissions (0 to 5, and -1 being 'new'). Blank if no affiliate.
affiliate_conversion_rate_ranking	Network ranking of affiliate's conversion rate (0 to 5, and -1 being 'new'). Blank if no affiliate.
affiliate_id	id of Invoca objectentifier of the affiliate
affiliate_id_from_network	ID of Affiliate object from the network as set on the Invoca affiliate
affiliate_payout_localized	Amount paid out to the affiliate
call_fee_localized	Telecommunications fee associated with transaction
call_result_description_detail	Status of the transaction
call_source_description	Source of the transaction
calling_phone_number	ID of Caller object Formatted as 10 digits like "8665551234".
city	City where transaction originated
connect_duration	Duration in seconds that the call that was connected to the call center
corrected_at	[Correction only] Date and time the transaction was corrected, in user's time zone, followed by offset from GMT
corrects_transaction_id	ID of [Correction only] object of the original transaction that this transaction updates. Values in this row are the corrected ones and should replace the original values. Same format as transaction_id.
duration	Duration of the call in seconds. Includes any time spent in an IVR tree before transferring to the call center.
ivr_duration	Duration in seconds that the call spent in the IVR tree
keypress_1	Name of the first key that was pressed
keypress_2	Name of the second key that was pressed
keypress_3	Name of the third key that was pressed
keypress_4	Name of the fourth key that was pressed
keypresses	List of unique keynames that were pressed during the call
margin_localized	Difference between advertiser_payin_localized and affiliate_payout_localized
matching_advertiser_payin_policies	List of advertiser policies that matched (base, bonus1, bonus2, etc.) to determine the advertiser payin, separated by +. For example, base+bonus1+bonus3. Note that if there was any advertiser payin, this field guaranteed to start with base.
matching_affiliate_payout_policies	List of affiliate policies that matched (base, bonus1, bonus2, etc.) to determine the affiliate payout, separated by +. For example, base+bonus2. Note that if there was any affiliate payout, this field guaranteed to start with base.
media_type	Media type of the transaction source
mobile	"Landline" or "Mobile" or empty string if type is unknown
opt_in_sms	Whether the caller opted in to receive an SMS promotion
original_order_id	[Sales reporting only] ID of the original transaction that this row is in reference to. Same format as transaction_id.
recording	URL to the call recording, if available
region	Region (state, province or country) where transaction originated
start_after_transaction_id	This is for internal purposes only. Ignore the contents of this field.
start_time_local	Start of the call in the API user's time zone, followed by offset from GMT
transaction_id	id of Globally unique objectentifier for this transaction. 11-character string like "29810-95701". This is the Primary Key of the results.
transaction_type	The type of transaction - Call, Sale or Web Conversion

Show Supported Values

filters

Filter

Array of field values to filter results byShow Filterable Fields

The following fields from the model can be filtered on.

Name	Description
added_to_conversions	Whether or not the Invoca transaction has been recorded as a HasOffers conversion
advertiser_call_fee_localized	Advertiser Telecommunications fee associated with transaction
advertiser_campaign_id	id of Invoca objectentifier of the campaign
advertiser_campaign_id_from_network	ID of Campaign object from the network as set on the advertiser campaign
advertiser_id	id of Invoca objectentifier of the advertiser
advertiser_id_from_network	ID of Advertiser object from the network as set on the Invoca advertiser
advertiser_payin_localized	Amount paid in by advertiser
affiliate_call_volume_ranking	Network ranking of affiliate's call volume (0 to 5, and -1 being 'new'). Blank if no affiliate.
affiliate_commissions_ranking	Network ranking of affiliate's commissions (0 to 5, and -1 being 'new'). Blank if no affiliate.
affiliate_conversion_rate_ranking	Network ranking of affiliate's conversion rate (0 to 5, and -1 being 'new'). Blank if no affiliate.
affiliate_id	id of Invoca objectentifier of the affiliate
affiliate_id_from_network	ID of Affiliate object from the network as set on the Invoca affiliate
affiliate_payout_localized	Amount paid out to the affiliate
call_fee_localized	Telecommunications fee associated with transaction
call_result_description_detail	Status of the transaction
call_source_description	Source of the transaction
calling_phone_number	ID of Caller object Formatted as 10 digits like "8665551234".
city	City where transaction originated
connect_duration	Duration in seconds that the call that was connected to the call center
corrected_at	[Correction only] Date and time the transaction was corrected, in user's time zone, followed by offset from GMT
corrects_transaction_id	ID of [Correction only] object of the original transaction that this transaction updates. Values in this row are the corrected ones and should replace the original values. Same format as transaction_id.
duration	Duration of the call in seconds. Includes any time spent in an IVR tree before transferring to the call center.
ivr_duration	Duration in seconds that the call spent in the IVR tree
keypress_1	Name of the first key that was pressed
keypress_2	Name of the second key that was pressed
keypress_3	Name of the third key that was pressed
keypress_4	Name of the fourth key that was pressed
keypresses	List of unique keynames that were pressed during the call
margin_localized	Difference between advertiser_payin_localized and affiliate_payout_localized
matching_advertiser_payin_policies	List of advertiser policies that matched (base, bonus1, bonus2, etc.) to determine the advertiser payin, separated by +. For example, base+bonus1+bonus3. Note that if there was any advertiser payin, this field guaranteed to start with base.
matching_affiliate_payout_policies	List of affiliate policies that matched (base, bonus1, bonus2, etc.) to determine the affiliate payout, separated by +. For example, base+bonus2. Note that if there was any affiliate payout, this field guaranteed to start with base.
media_type	Media type of the transaction source
mobile	"Landline" or "Mobile" or empty string if type is unknown
opt_in_sms	Whether the caller opted in to receive an SMS promotion
original_order_id	[Sales reporting only] ID of the original transaction that this row is in reference to. Same format as transaction_id.
recording	URL to the call recording, if available
region	Region (state, province or country) where transaction originated
start_after_transaction_id	This is for internal purposes only. Ignore the contents of this field.
start_time_local	Start of the call in the API user's time zone, followed by offset from GMT
transaction_id	id of Globally unique objectentifier for this transaction. 11-character string like "29810-95701". This is the Primary Key of the results.
transaction_type	The type of transaction - Call, Sale or Web Conversion

Show Filterable Fields

sort

Sort

Array of fields and directions to sort results byShow Sortable Fields

The following fields from the model can be sorted in either ascending (ASC) or descending (DESC) order.

Name	Description
added_to_conversions	Whether or not the Invoca transaction has been recorded as a HasOffers conversion
advertiser_call_fee_localized	Advertiser Telecommunications fee associated with transaction
advertiser_campaign_id	id of Invoca objectentifier of the campaign
advertiser_campaign_id_from_network	ID of Campaign object from the network as set on the advertiser campaign
advertiser_id	id of Invoca objectentifier of the advertiser
advertiser_id_from_network	ID of Advertiser object from the network as set on the Invoca advertiser
advertiser_payin_localized	Amount paid in by advertiser
affiliate_call_volume_ranking	Network ranking of affiliate's call volume (0 to 5, and -1 being 'new'). Blank if no affiliate.
affiliate_commissions_ranking	Network ranking of affiliate's commissions (0 to 5, and -1 being 'new'). Blank if no affiliate.
affiliate_conversion_rate_ranking	Network ranking of affiliate's conversion rate (0 to 5, and -1 being 'new'). Blank if no affiliate.
affiliate_id	id of Invoca objectentifier of the affiliate
affiliate_id_from_network	ID of Affiliate object from the network as set on the Invoca affiliate
affiliate_payout_localized	Amount paid out to the affiliate
call_fee_localized	Telecommunications fee associated with transaction
call_result_description_detail	Status of the transaction
call_source_description	Source of the transaction
calling_phone_number	ID of Caller object Formatted as 10 digits like "8665551234".
city	City where transaction originated
connect_duration	Duration in seconds that the call that was connected to the call center
corrected_at	[Correction only] Date and time the transaction was corrected, in user's time zone, followed by offset from GMT
corrects_transaction_id	ID of [Correction only] object of the original transaction that this transaction updates. Values in this row are the corrected ones and should replace the original values. Same format as transaction_id.
duration	Duration of the call in seconds. Includes any time spent in an IVR tree before transferring to the call center.
ivr_duration	Duration in seconds that the call spent in the IVR tree
keypress_1	Name of the first key that was pressed
keypress_2	Name of the second key that was pressed
keypress_3	Name of the third key that was pressed
keypress_4	Name of the fourth key that was pressed
keypresses	List of unique keynames that were pressed during the call
margin_localized	Difference between advertiser_payin_localized and affiliate_payout_localized
matching_advertiser_payin_policies	List of advertiser policies that matched (base, bonus1, bonus2, etc.) to determine the advertiser payin, separated by +. For example, base+bonus1+bonus3. Note that if there was any advertiser payin, this field guaranteed to start with base.
matching_affiliate_payout_policies	List of affiliate policies that matched (base, bonus1, bonus2, etc.) to determine the affiliate payout, separated by +. For example, base+bonus2. Note that if there was any affiliate payout, this field guaranteed to start with base.
media_type	Media type of the transaction source
mobile	"Landline" or "Mobile" or empty string if type is unknown
opt_in_sms	Whether the caller opted in to receive an SMS promotion
original_order_id	[Sales reporting only] ID of the original transaction that this row is in reference to. Same format as transaction_id.
recording	URL to the call recording, if available
region	Region (state, province or country) where transaction originated
start_after_transaction_id	This is for internal purposes only. Ignore the contents of this field.
start_time_local	Start of the call in the API user's time zone, followed by offset from GMT
transaction_id	id of Globally unique objectentifier for this transaction. 11-character string like "29810-95701". This is the Primary Key of the results.
transaction_type	The type of transaction - Call, Sale or Web Conversion

Show Sortable Fields

limit

Integer

Objects per page to return; defaults to returning all found

page

Integer

Result page to return, based on limit value; defaults to 1

GET Response Notes

Associative array of Ring Revenue transactions.

Return response will be in the following format: array.

API Call Builder

Javascript is required to use the API Call Builder.