ACCESSTRADE-Support

Report APIs

Get Conversion Report

• GET /v1/publishers/me/reports/conversion
• Publisher API Authentication required
• Request:
  • Query string:
    • fromDate=2016-01-01T00:00:00+09:00 (a date in a format of yyyy-MM-ddT00:00:00+09:00 required)
    • toDate=2016-01-31T00:00:00+09:00 (a date in a format of yyyy-MM-ddT00:00:00+09:00 required)
    • siteId=12
    • campaignId=12
    • periodBase=CONFIRMATION_DATE
    • conversionStatuses=REJECTED|APPROVED

      Note:

      1. Value of fromDate and toDate should be url encoded.
         Example : encoded value of 2016-01-01T00:00:00+09:00 will be 2016-01-01T00%3A00%3A00%2B09%3A00
      2. The date and time of the conversion will be in the time zone specified in request
         Example : fromDate or toDate is 2016-01-01T00:00:00+09:00 in the request,
         then the date and time of the conversion will be in time zone +09:00 also.
• periodBase

  CONVERSION_DATE (default),
  CONFIRMATION_DATE,
  POSTBACK_ERROR_DATE,
  UPDATED_DATE
  

• conversionStatus

  APPROVED,
  PENDING,
  REJECTED
  

• Response:

  {
    "totalConversionsCount": 2,
    "totalReward": 1800,
    "conversionReportItems": [
        {
            "conversionId": 123456,
            "siteId": 321,
            "siteName": "My Test Site",
            "campaignId": 654,
            "campaignName": "Lazada Campaign 1",
            "creativeId": 987,
            "creativeName": "Edamame",
            "verificationId": "ab123",
            "merchantCountryCode": "MY",
            "publisherCountryCode": "MY",
            "clickTime": "2016-12-01 08:05:53",
            "conversionTime": "2016-12-02 08:12:44",
            "confirmationTime": "2016-12-25 01:11:44",
            "status": "APPROVED",
            "reward": 600,
            "transactionAmount": 1500,
            "sessionId": "jkfsjgsjghsdighfj",
            "parameters": [
                {
                    "name": "customParamName",
                    "value": "customParamValue"
                },
                {
                    "name": "otherParamName",
                    "value": "otherParamValue"
                }
            ],
            "products": [
                {
                    "id": "someProductId",
                    "unitPrice": 420,
                    "categoryId": "someCategoryId",
                    "quantity": 3,
                    "reward": 15,
                    "productConversionId": 123456
                },
                {
                    "id": "someOtherProductId",
                    "unitPrice": 4500,
                    "categoryId": "someOtherCategoryId",
                    "quantity": 2,
                    "reward": 150,
                    "productConversionId": 123457
                }
            ],
            "customerType": "new",
            "ipAddress": "127.0.0.1",
            "country": "Japan",
            "city": "Tokyo",
            "userAgent": "Mozilla/5.0 (Linux; Android 9; vivo 1904) AppleWebKit/537.36",
            "deviceType": "Desktop",
            "deviceBrand": "SAMSUNG",
            "browser": "Chrome",
            "language": "en",
            "referralDomain": "https://hello.co.id/universal-link",
            "referralUrl": "https://hello.co.id/universal-link?utm_source=XXX&utm_medium=affiliates&utm_campaign=XXX&utm_content=XXX&...",
            "postbackStatus": "NEEDED",
            "postbackErrorCount": 0,
            "lastedPostbackTime": "2016-12-01 08:05:53",
            "postbackUrl": "https://helloWorld.co.id/universal-link"
        },
        {
            "conversionId": 123457,
            "siteId": 321,
            "siteName": "My Test Site",
            "campaignId": 654,
            "campaignName": "Lazada Campaign 2",
            "creativeId": 987,
            "creativeName": "Edamame",
            "verificationId": "cd456",
            "merchantCountryCode": "MY",
            "publisherCountryCode": "MY",
            "clickTime": "2016-12-01 08:05:53",
            "conversionTime": "2016-12-02 08:12:44",
            "confirmationTime": "2016-12-25 01:11:44",
            "status": "PENDING",
            "reward": 1200,
            "transactionAmount": 1500,
            "sessionId": "jkfsjgsjghsdighfj",
            "parameters": [
                {
                    "name": "customParamName",
                    "value": "customParamValue"
                },
                {
                    "name": "otherParamName",
                    "value": "otherParamValue"
                }
            ],
            "products": [],
            "customerType": "new",
            "ipAddress": "127.0.0.1",
            "country": "Japan",
            "city": "Tokyo",
            "userAgent": "Mozilla/5.0 (Linux; Android 9; vivo 1904) AppleWebKit/537.36",
            "deviceType": "Desktop",
            "deviceBrand": "SAMSUNG",
            "browser": "Chrome",
            "language": "en",
            "referralDomain": "https://hello.co.id/universal-link",
            "referralUrl": "https://hello.co.id/universal-link?utm_source=XXX&utm_medium=affiliates&utm_campaign=XXX&utm_content=XXX&...",
            "postbackStatus": "NEEDED",
            "postbackErrorCount": 0,
            "lastedPostbackTime": "2016-12-01 08:05:53",
            "postbackUrl": "https://helloWorld.co.id/universal-link"
        }
    ]
  }
  

• deviceType

  DESKTOP,
  ANDROID,
  IPHONE,
  ANDROID_TAB,
  IPAD