ACCESSTRADE-Support

Report APIs

Get Conversion Report

Endpoint: GET /v1/publishers/me/reports/conversion

Authentication: Publisher API Authentication required

Rate Limits

Required Parameters

Parameter Format Description
fromDate yyyy-MM-ddTHH:mm:ss Start date (URL encoded)
toDate yyyy-MM-ddTHH:mm:ss End date (URL encoded)

Optional Parameters

Parameter Values Description
siteId Integer Specific site ID (default: all owned sites)
campaignId Integer Specific campaign ID (default: all campaigns)
periodBase CONVERSION_DATE, CONFIRMATION_DATE, POSTBACK_ERROR_DATE, UPDATED_DATE Date filter basis
conversionStatuses APPROVED, PENDING, REJECTED Filter by status

Important Notes

  1. URL Encoding: Date values must be URL encoded
    • Example: 2016-01-01T00:00:002016-01-01T00%3A00%3A00
  2. Timezone: Time zone parameters are ignored; local time is used

Example Request

GET /v1/publishers/me/reports/conversion?fromDate=2016-01-01T00%3A00%3A00&toDate=2016-01-07T00%3A00%3A00&siteId=12

Response Format

{
    "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"
        }
    ]
}

Device Types


Get Conversion Report Details

Endpoint: GET /v1/publishers/me/reports/conversion/detail

Authentication: V1 Request Signature required

Required Parameters

Parameter Format Description
fromDate yyyy-MM-ddTHH:mm:ss+TZ Start date with timezone
toDate yyyy-MM-ddTHH:mm:ss+TZ End date with timezone

Optional Parameters

Parameter Type Description
siteId Integer Filter by site
campaignId Integer Filter by campaign
periodBase String Date filter basis
conversionStatuses String Filter by status (pipe-separated)
invoiceKey String Invoice identifier
isPendingForMerchantPayment Boolean Payment status filter
page Integer Page number (default: 1)
limit Integer Results per page (default: 10)

Example Request

GET /v1/publishers/me/reports/conversion/detail?fromDate=2023-01-01T00:00:00+09:00&toDate=2023-01-31T00:00:00+09:00&page=1&limit=10

Response Format

{
    "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&...",
        "2": "/v1/publishers/me/reports/conversion/detail?limit=10&page=2&...",
        "3": "/v1/publishers/me/reports/conversion/detail?limit=10&page=3&...",
        "4": "/v1/publishers/me/reports/conversion/detail?limit=10&page=4&...",
        "5": "/v1/publishers/me/reports/conversion/detail?limit=10&page=5&...",
        "6": "/v1/publishers/me/reports/conversion/detail?limit=10&page=6&...",
        "7": "/v1/publishers/me/reports/conversion/detail?limit=10&page=7&..."
    }
}