Conversion Import

HTTP method End Point Description
POST /network/conversion-import Upload / Edit Conversions

Request Parameters

If request is sent without click_id it will by default create a new conversion

Field Type Description Required
click_id string (24 character id) vNative Click ID No
campaign_id int or string Either the numeric id or vNative 24 character campaign id Yes (If creating new conversion)
publisher_id string Either the numeric id of vNative 24 character publisher ID Yes (if creating new conversion)
goal_id string 24 character ID Goal ID associated with this campaign No
txn_id string Unique identifier provided No
sub1 string Sub ID 1 No
sub2 string Sub ID 2 No
sub3 string Sub ID 3 No
sub4 string Sub ID 4 No
sale_amount float Sale Amount for the campaign No
sale_currency string Default Value = USD No
method string Default Value = acquisition (Other Values - pixel, app_install) No
ipaddr string IP address from which this conversion was requested No
status string Default Value - approved (Other value - cancelled, pending, rejected) No
created string Format = YYYY-MM-DD H:i:s (The time for recording conversion will be considered according to network timezone) No
referer string To store the referring page No

Response body parameters

curl -i -X POST \
   -H "X-Api-Key: {key}" \
   -H "Content-Type:application/json" \
   -d \
'{
  "conversions": [
    {
      "campaign_id": 86,
      "publisher_id": "57c6c75934243d930c8b4581",
      "sale_amount": 66,
      "sale_currency": "INR",
      "created": "2017-10-26 22:33:00"
    },
    {
      "campaign_id": 86,
      "publisher_id": "57c6c75934243d930c8b4581",
      "sale_amount": 132,
      "sale_currency": "INR",
      "txn_id": "3153d3ff-5391-35e6-55fb-9ea6ed2a87bf",
      "created": "2017-10-26 22:33:00"
    }
  ]
}' \
 'https://api.vnative.com/network/conversion-import'

Sample Response

{
    "success": true,
    "data": {
        "message": "Job has been queued!!",
        "job": {
            "type": "import",
            "subType": "job_import_conversion",
            "relatedObject": {
                "csvPath": "53beda1b.csv"
            },
            "resource": "Conversion",
            "resourceId": null,
            "state": "pending",
            "_id": "59f2243b89d4465a760b95c2"
        }
    }
}

This endpoint will create a background job which will be processed by the system. The status of the job can be viewed using the jobs endpoint

*Notes

  • Sale Amount will only be considered to calculate payout when the campaign objective is set Sales
  • Valid Sale Currencies = USD, INR, AUD, EUR, TRY, IDR, THB, MYR, PHP, VND, RUR, PLN

  • If Goal ID is passed then payout will be defined by Goal
  • If Both Goal ID and Sale Amount are given then conversion will be marked as Sale
  • If invalid Click ID is given then record will be ignored
  • If Click ID is given then system tries to find conversion with combination of [Click id + txn id + goal id], if the conversion is found then all the other fields excluding campaign id, publisher id are updated
  • If more than 10 errors are generated while importing the conversions then the process will be halted in between

results matching ""

    No results matching ""