Store/Update Conversion (Web)

This API request stores web conversion data such as a form, for a specific site using the HTTP method PUT. The request includes the following parameters:

Headers:

AuthorizationstringRequired

The authorization token for accessing the API. The header value should be set to "Bearer {your-access-token}", where {your-access-token} is the access token assigned to the user.

Request Body(JSON payload):

The data containing the conversion information to store/update. The payload should include the following parameters:

CaptureDateTimestringRequired

The date and time the conversion was captured. Must be in ISO 8601 format. yyyy-MM-dd

VisitorIdentifierOptionsArrayRequired

An array of visitor identifiers. Each item in the array should include the following parameters:

KeystringRequired

The key for the visitor identifier. Accepted Keys: EmailAddress, PhoneNumber, RaId, CookieValue

ValuestringRequired

The value for the visitor identifier.

PayloadArrayRequired

An array of payload. Each item in the array should include the following parameters:

KeystringRequired

The key for the payload item.

ValuestringRequired

The value for the payload item.

LandingPageUrlOverridestring

The Landing Page Url you would like to set for this form. If you do not set a MarketingChannelOverride then this URL will be used for attribution.

Ensure this is a well formatted URL. e.g.https://www.ruleranalytics.com/

MarketingChannelOverridestring

The Marketing Channel Override you would like to provide: See table below for reference values.

SourceCategoryOverridestring

The Source Category Override you would like to provide: See table below for reference values.


SourceMarketing Channels
UnMatchedNotApplicable
DirectNotApplicable
OfflineNotApplicable
ReferralNotApplicable
EmailNotApplicable
SMSNotApplicable
GooglePaid, Organic, Places
YahooPaid, Organic
BingPaid, Organic
FacebookPaid, Organic
TwitterPaid, Organic
LinkedInPaid, Organic
PinterestPaid, Organic
InstagramPaid, Organic
YouTubePaid, Organic
TikTokPaid, Organic
RedditPaid, Organic
SnapchatPaid, Organic
AdRollPaid, Organic
DuckDuckGoPaid, Organic
OutbrainPaid
StackAdaptPaid
AwinPaid
KlaviyoPaid
CriteoPaid
ImpactPaid
ShareASalePaid
TaboolaPaid
TheTradeDeskPaid
JourneyNotApplicable
Note that this source will join the form onto an existing touchpoint if one is found to match.
Other sources will create a new touchpoint.
Custom SourceCustom
Use this method when you want to upload to one of your custom sources. Replace Custom Source with the name of your source


The {your-access-token} parameter in the authorization header should be replaced with the appropriate access token.

Request
PUT
{siteId}/conversion/web/upload
curl -X PUT \ 'https://rest.rulerapi.com/v1/{siteId}/conversion/web/upload' \ -H 'Authorization: Bearer {your-access-token}' \ -H 'Content-Type: application/json' \ -d { "CaptureDateTime": "{captureDateTime}", "VisitorIdentifierOptions": [{ "Key": "{key}", "Value": "{value}" }], "Payload": [{ "key": "{key}", "value": "{value}" }], "MarketingChannelOverride" : "{marketingChannelOverride}", "SourceCategoryOverride": "{sourceCategoryOverride}", "LandingPageUrlOverride": "{landingPageUrlOverride}" }
Response
Status: 202