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

Get Conversion Report Details

GET /v1/publishers/me/reports/conversion/detail
V1 Request Signature request
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
  - invoiceKey=ATVN
  - isPendingForMerchantPayment=true
  - page=1
  - limit=10

Response:

[
  {
  "content": [
      {
          "verificationId": "230127DF067PXV",
          "status": "PENDING",
          "clickTime": "2023-01-26 19:32:17",
          "conversionTime": "2023-01-26 20:06:36",
          "reward": 1980.00,
          "hasProduct": true
      },
      {
          "verificationId": "230127EDBDFDG5",
          "status": "PENDING",
          "clickTime": "2023-01-26 04:14:45",
          "conversionTime": "2023-01-27 05:09:38",
          "reward": 17699.00,
          "hasProduct": true
      },
      {
          "verificationId": "230127EDBDFDG5",
          "status": "APPROVED",
          "clickTime": "2023-01-26 04:14:45",
          "conversionTime": "2023-01-27 05:09:38",
          "confirmationTime": "2023-02-27 05:09:38",
          "reward": 3675.00,
          "hasProduct": true
      },
      {
          "verificationId": "230128GMUA3MB4",
          "status": "PENDING",
          "clickTime": "2023-01-27 08:52:16",
          "conversionTime": "2023-01-28 02:29:07",
          "reward": 4395.00,
          "hasProduct": true
      },
      {
          "verificationId": "230128GVQ3QKMJ",
          "status": "PENDING",
          "clickTime": "2023-01-27 04:11:42",
          "conversionTime": "2023-01-28 04:49:57",
          "reward": 224.00,
          "hasProduct": true
      },
      {
          "verificationId": "230129KK6WAE6X",
          "status": "PENDING",
          "clickTime": "2023-01-28 14:19:03",
          "conversionTime": "2023-01-29 06:37:48",
          "reward": 6420.00,
          "hasProduct": true
      },
      {
          "verificationId": "230129KXGVQGXK",
          "status": "PENDING",
          "clickTime": "2023-01-29 09:28:26",
          "conversionTime": "2023-01-29 10:00:14",
          "reward": 5007.00,
          "hasProduct": true
      },
      {
          "verificationId": "230129M4S2GJ0R",
          "status": "APPROVED",
          "clickTime": "2023-01-26 13:12:54",
          "conversionTime": "2023-01-29 11:52:12",
          "confirmationTime": "2023-02-28 11:52:12",
          "reward": 5002.00,
          "hasProduct": true
      },
      {
          "verificationId": "230129MGAM3P4D",
          "status": "PENDING",
          "clickTime": "2023-01-29 09:10:21",
          "conversionTime": "2023-01-29 15:18:51",
          "reward": 1146.00,
          "hasProduct": true
      },
      {
          "verificationId": "230130NYN03RB2",
          "status": "PENDING",
          "clickTime": "2023-01-29 08:48:52",
          "conversionTime": "2023-01-30 05:25:45",
          "reward": 960.00,
          "hasProduct": true
      }
  ],
  "pages": {
      "1": "/v1/publishers/me/reports/conversion/detail?limit=10&page=1&fromDate=2022-12-01T00:00:00Z&isPendingForMerchantPayment=false&periodBase=CONVERSION_DATE&campaignId=679&toDate=2023-05-30T00:00:00Z&siteId=1118636&conversionStatuses=[PENDING,APPROVED,REJECTED]",
      "2": "/v1/publishers/me/reports/conversion/detail?limit=10&page=2&fromDate=2022-12-01T00:00:00Z&isPendingForMerchantPayment=false&periodBase=CONVERSION_DATE&campaignId=679&toDate=2023-05-30T00:00:00Z&siteId=1118636&conversionStatuses=[PENDING,APPROVED,REJECTED]",
      "3": "/v1/publishers/me/reports/conversion/detail?limit=10&page=3&fromDate=2022-12-01T00:00:00Z&isPendingForMerchantPayment=false&periodBase=CONVERSION_DATE&campaignId=679&toDate=2023-05-30T00:00:00Z&siteId=1118636&conversionStatuses=[PENDING,APPROVED,REJECTED]",
      "4": "/v1/publishers/me/reports/conversion/detail?limit=10&page=4&fromDate=2022-12-01T00:00:00Z&isPendingForMerchantPayment=false&periodBase=CONVERSION_DATE&campaignId=679&toDate=2023-05-30T00:00:00Z&siteId=1118636&conversionStatuses=[PENDING,APPROVED,REJECTED]",
      "5": "/v1/publishers/me/reports/conversion/detail?limit=10&page=5&fromDate=2022-12-01T00:00:00Z&isPendingForMerchantPayment=false&periodBase=CONVERSION_DATE&campaignId=679&toDate=2023-05-30T00:00:00Z&siteId=1118636&conversionStatuses=[PENDING,APPROVED,REJECTED]",
      "6": "/v1/publishers/me/reports/conversion/detail?limit=10&page=6&fromDate=2022-12-01T00:00:00Z&isPendingForMerchantPayment=false&periodBase=CONVERSION_DATE&campaignId=679&toDate=2023-05-30T00:00:00Z&siteId=1118636&conversionStatuses=[PENDING,APPROVED,REJECTED]",
      "7": "/v1/publishers/me/reports/conversion/detail?limit=10&page=7&fromDate=2022-12-01T00:00:00Z&isPendingForMerchantPayment=false&periodBase=CONVERSION_DATE&campaignId=679&toDate=2023-05-30T00:00:00Z&siteId=1118636&conversionStatuses=[PENDING,APPROVED,REJECTED]"
  }
}
]

ACCESSTRADE-Support

Report APIs

Get Conversion Report

Note:

Get Conversion Report Details