Conversions
This SOAP service provides operations for managing your conversions.
Service endpoint URL (WSDL definition) is https://api.oddbytes.com/?v3=conversions.wsdl .
Service Operation | ||
Operation | Result Type | Descrition |
Returns the list of ID values for your already existing conversions. Optionally, returned list can also contain ID values of your currently deleted conversions. | ||
Returns the parameters stored for your already existing conversions, please see type Conversion for more details. | ||
Returns available options for conversions validation windows (lookback periods). |
getConversionIds
Returns the list of ID values for your already existing conversions. Optionally, returned list can also contain ID values of your currently deleted conversions.
Property | Type | Null Allowed | Description |
filterNames | string[] (1:100) | ✔ | Optional filter specification for conversions names |
includeDeleted | bool | Option for also fetching ID values of your currently deleted conversions |
ConversionIdsResult
Property | Type | Null Allowed | Description |
ids | unsignedInt[] (0:unbound) | List of conversion ID values for non–deleted conversions | |
deletedIds | unsignedInt[] (0:unbound) | List of conversion ID values for deleted conversions |
getConversions
Returns the parameters stored for your already existing conversions, please see type Conversion for more details.
Property | Type | Null Allowed | Description |
conversionIds | unsignedInt[] (1:300) | List of conversion ID values | |
fetchStats | bool | ✔ | Option for also fetching brief stats data for the returned conversions |
ConversionsResult
Property | Type | Null Allowed | Description |
conversions | Conversion[] (0:unbound) | Conversions data stored for your already existing non–deleted conversions | |
deletedIds | unsignedInt[] (0:unbound) | List of conversion ID values for deleted conversions |
getConversionWindows
Returns available options for conversions validation windows (lookback periods).
Property | Type | Null Allowed | Description |
ConversionWindowsResult
Property | Type | Null Allowed | Description |
conversionWindows | ConversionWindow[] (0:unbound) | Available options for conversions validation windows (lookback periods) |
ConversionIdsResult
Return value type used while fetching ID values of your conversions.
Property | Type | Null Allowed | Description |
ids | unsignedInt[] (0:unbound) | List of conversion ID values for non–deleted conversions | |
deletedIds | unsignedInt[] (0:unbound) | List of conversion ID values for deleted conversions |
ConversionsResult
Return value type used while fetching stored data for your already existing conversions.
Property | Type | Null Allowed | Description |
conversions | Conversion[] (0:unbound) | Conversions data stored for your already existing non–deleted conversions | |
deletedIds | unsignedInt[] (0:unbound) | List of conversion ID values for deleted conversions |
Conversion
Return value type used while fetching stored data for your already existing non–deleted conversion.
Property | Type | Null Allowed | Description |
id | unsignedInt | Conversion ID value | |
name | string | Conversion name | |
status | ConversionStatus | Conversion status | |
category | ConversionCategory | Category of tracked conversion | |
revenue | float | ✔ | Your revenue generated by this conversion |
window | unsignedInt | Tracking code / pixel lookback period; | |
useRepeated | ConversionUseRepeated | Counting multiple conversions from the same impression or click | |
created | dateTime | Date and time of conversion creation | |
modified | dateTime | Date and time of last conversion modification | |
stats | ✔ | Brief daily, monthly and total stats data for the conversion, returned only if requested; please see operation getConversions() for more details |
ConversionStats
Return value type used while fetching brief daily, monthly and total stats data for your already existing non–deleted conversion.
Property | Type | Null Allowed | Description |
conversionsToday | unsignedInt | Accounted number of validated conversions for today | |
conversionsMonth | unsignedInt | Accounted number of validated conversions for current month | |
conversionsTotal | unsignedInt | Total number of validated conversions | |
unmatchedToday | unsignedInt | Accounted number of unmatched conversion requests for today | |
unmatchedMonth | unsignedInt | Accounted number of unmatched conversion requests for current month | |
unmatchedTotal | unsignedInt | Total number of unmatched conversion requests | |
lastConverted | dateTime | ✔ | Date and time of last validated conversion; receiving Null means having no validated conversions yet |
ConversionWindowsResult
Return value type used while fetching available options for conversions validation windows (lookback periods).
Property | Type | Null Allowed | Description |
conversionWindows | ConversionWindow[] (0:unbound) | Available options for conversions validation windows (lookback periods) |
ConversionWindow
Return value type used while fetching available option for conversions validation windows (lookback periods).
Property | Type | Null Allowed | Description |
days | unsignedInt | Tracking code / pixel lookback period, specified as a number of days | |
description | string | Brief description for the validation window option |