Spec - Website Conversions

Table Of Contents

• Get Website Conversions
• Add Website Conversions
• Edit Website Conversions
• Delete Website Conversions

Get Website Conversions

This API retrieves the conversions under the user account.

Input

• account_id (required for shared access users)
• group_id (required for shared access users)
• conversion_id
• contact_id
• start_datetime (YYYYMMDDHHMMSS)
• end_datetime (YYYYMMDDHHMMSS)

Output

Success or failure. List of conversions under the user account.

Example Request

<GetWebsiteConversionsRequest/>

Example Request (Shared Access)

<GetWebsiteConversionsRequest account_id="12345" group_id="1"/>

Example Request (Filter)

<GetWebsiteConversionsRequest start_datetime="20160101000000" end_datetime="20171231240000" />

Example Response

<GetWebsiteConversionsResponse>
    <Result>Success</Result>
    <WebsiteConversions>
        <WebsiteConversion>
            <Value>0.00</Value>
            <ConversionCode>1234</ConversionCode>
            <ContactID>767</ContactID>
            <Stage>0</Stage>
            <ConversionID>204</ConversionID>
            <Datetime>20171012075500</Datetime>
        </WebsiteConversion>
        <WebsiteConversion>
            <Value>1234.00</Value>
            <ConversionCode>1234</ConversionCode>
            <ContactID>767</ContactID>
            <Stage>1234</Stage>
            <ConversionID>206</ConversionID>
            <Datetime>20171012091203</Datetime>
        </WebsiteConversion>
        <WebsiteConversion>
            <Value></Value>
            <ConversionCode>1234</ConversionCode>
            <ContactID>123</ContactID>
            <Stage></Stage>
            <ConversionID>209</ConversionID>
            <Datetime>20171012122125</Datetime>
        </WebsiteConversion>
    </WebsiteConversions>
    <TotalWebsiteConversions>3</TotalWebsiteConversions>
</GetWebsiteConversionsResponse>

Add Website Conversions

This API call adds new conversion(s) to the user account.

Input

• account_id (required for shared access users)
• group_id (required for shared access users)
• request_id (optional)
• ConversionCode (required)
• ContactID
• Datetime (YYYYMMDDHHMMSS)
• Value
• Stage

Output

Success or failure for each conversions with its new ConversionID.

Example Request

<AddWebsiteConversionsRequest>
    <WebsiteConversions>
        <WebsiteConversion request_id="a1b2c3">
            <ConversionCode>1234</ConversionCode>
            <ContactID>623</ContactID>
            <Datetime>20171012123400</Datetime>
            <Value>20</Value>
            <Stage>1</Stage>
        </WebsiteConversion>
        <WebsiteConversion request_id="d4e5f6">
            <ConversionCode>4321</ConversionCode>
            <ContactID>623</ContactID>
        </WebsiteConversion>
    </WebsiteConversions>
</AddWebsiteConversionsRequest>

Example Request (Shared Access)

<AddWebsiteConversionsRequest account_id="12345" group_id="1">
    <WebsiteConversions>
        <WebsiteConversion>
            <ConversionCode>4321</ConversionCode>
            <ContactID>623</ContactID>
        </WebsiteConversion>
    </WebsiteConversions>
</AddWebsiteConversionsRequest>

Example Response

<AddWebsiteConversionsResponse>
    <WebsiteConversions>
        <WebsiteConversion request_id="a1b2c3">
            <Result>Success</Result>
            <WebsiteConversionID>224</WebsiteConversionID>
        </WebsiteConversion>
        <WebsiteConversion request_id="d4e5f6">
            <Result>Success</Result>
            <WebsiteConversionID>227</WebsiteConversionID>
        </WebsiteConversion>
    </WebsiteConversions>
</AddWebsiteConversionsResponse>

Edit Website Conversions

This API call update existing conversion(s) in the user account.

Input

• account_id (required for shared access users)
• group_id (required for shared access users)
• conversion_id (required)
• request_id (optional)
• ConversionCode
• Datetime (YYYYMMDDHHMMSS)
• Value
• Stage

Output

Success or failure for each conversions with its existing ConversionID.

Example Request

<EditWebsiteConversionsRequest>
    <WebsiteConversions>
        <WebsiteConversion conversion_id="230" request_id="a1b2c3">
            <ConversionCode>1234</ConversionCode>
            <Datetime>20171012123400</Datetime>
            <Value>20</Value>
            <Stage>1</Stage>
        </WebsiteConversion>
        <WebsiteConversion conversion_id="233" request_id="d4e5f6">
            <ConversionCode>4321</ConversionCode>
            <Value>40</Value>
        </WebsiteConversion>
    </WebsiteConversions>
</EditWebsiteConversionsRequest>

Example Request (Shared Access)

<EditWebsiteConversionsRequest account_id="12345" group_id="1">
    <WebsiteConversions>
        <WebsiteConversion conversion_id="230">
            <ConversionCode>1234</ConversionCode>
            <Datetime>20171012123400</Datetime>
            <Value>20</Value>
            <Stage>1</Stage>
        </WebsiteConversion>
        <WebsiteConversion conversion_id="233">
            <ConversionCode>4321</ConversionCode>
            <Value>40</Value>
        </WebsiteConversion>
    </WebsiteConversions>
</EditWebsiteConversionsRequest>

Example Response

<EditWebsiteConversionsResponse>
    <WebsiteConversions>
        <WebsiteConversion request_id="a1b2c3">
            <Result>Success</Result>
            <WebsiteConversionID>230</WebsiteConversionID>
        </WebsiteConversion>
        <WebsiteConversion request_id="d4e5f6">
            <Result>Success</Result>
            <WebsiteConversionID>233</WebsiteConversionID>
        </WebsiteConversion>
    </WebsiteConversions>
</EditWebsiteConversionsResponse>

Delete Website Conversions

This API call removes conversion(s) from the user account.

Input

• account_id (required for shared access users)
• group_id (required for shared access users)
• conversion_id (required)
• request_id (optional)

Output

Success or failure for each conversions with its deleted ConversionID.

Example Request

<DeleteWebsiteConversionsRequest>
    <WebsiteConversions>
        <WebsiteConversion conversion_id="224" request_id="a1b2c3" />
        <WebsiteConversion conversion_id="227" request_id="d4e5f6" />
    </WebsiteConversions>
</DeleteWebsiteConversionsRequest>

Example Request (Shared Access)

<DeleteWebsiteConversionsRequest account_id="12345" group_id="1">
    <WebsiteConversions>
        <WebsiteConversion conversion_id="224" />
        <WebsiteConversion conversion_id="227" />
    </WebsiteConversions>
</DeleteWebsiteConversionsRequest>

Example Response

<DeleteWebsiteConversionsResponse>
    <WebsiteConversions>
        <WebsiteConversion request_id="a1b2c3">
            <Result>Success</Result>
            <WebsiteConversionID>224</WebsiteConversionID>
        </WebsiteConversion>
        <WebsiteConversion request_id="d4e5f6">
            <Result>Success</Result>
            <WebsiteConversionID>227</WebsiteConversionID>
        </WebsiteConversion>
    </WebsiteConversions>
</DeleteWebsiteConversionsResponse>