Developer Report Retrieval

1. Overview

The Carty Developer Platform provides the Developer Report Retrieval API, allowing developers to fetch report data via a server-side interface.
The API supports date-based statistics and paginated responses, making it convenient for data analysis, revenue reconciliation, and operational monitoring.

---

2. API Information

• API Name: Developer Report Retrieval
• Endpoint: /api/report/out-search
• HTTP Method: POST
• Encoding: UTF-8
• Content-Type: application/json

2.1 Domain

• Production Environment:
  https://developer.gocarty.net/

• Full Request URL Example:

  https://developer.gocarty.net/api/report/out-search

---

3. Authentication (Authorization)

This API uses API Key authentication.

• Request Header: Authorization
• Example Value: rk_0jmtmwkz8grugecy1bp7syh4e6wgg4oa
• How to Obtain: Retrieve it from the apikeys module in the system dashboard

⚠️ Please keep your API Key secure and do not expose it in public repositories.

---

4. Request Parameters

4.1 Header Parameters

Parameter	Required	Type	Description
Authorization	Yes	String	API Key
Content-Type	Yes	String	Must be application/json

---

4.2 Body Parameters (JSON)

Parameter	Required	Type	Description
start_date	Yes	String	Start date, format: YYYY-MM-DD
end_date	Yes	String	End date, format: YYYY-MM-DD (must be ≥ start_date)
page	No	Int	Page number, default is 1
page_size	No	Int	Number of records per page, default is 10

Request Example

{
  "start_date": "2026-01-14",
  "end_date": "2026-01-14",
  "page": 1,
  "page_size": 10
}

---

5. Response Parameters

5.1 Response Structure

Field	Type	Description
code	Int	Status code: 0 indicates success, non-0 indicates failure
message	String	Response message
data	Object	Data object

---

5.2 data.list Fields

Field	Type	Description
date	String	Date (YYYY-MM-DD)
bid_type	Int	Bid type
request	Int	Number of requests
fill	Int	Number of fills
impression	Int	Number of impressions
click	Int	Number of clicks
revenue	Number	Developer revenue
click_rate	Number	Click-through rate (%)
ecpm	Number	eCPM
ecpc	Number	eCPC
fill_rate	Number	Fill rate (%)
impression_rate	Number	Impression rate (%)

---

5.3 data.page Fields

Field	Type	Description
current	Int	Current page
page_size	Int	Records per page
total	Int	Total records

---

6. Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "date": "2026-01-14",
        "bid_type": 2,
        "request": 473541,
        "fill": 288414,
        "impression": 164519,
        "click": 30095,
        "revenue": 470.74,
        "click_rate": 18.29,
        "ecpm": 2.86,
        "ecpc": 0.02,
        "fill_rate": 60.91,
        "impression_rate": 57.04
      }
    ],
    "page": {
      "current": 1,
      "page_size": 10,
      "total": 1
    }
  }
}

---

7. Request Example (curl)

curl --location --request POST 'https://developer.gocarty.net/api/report/out-search' \
--header 'Authorization: rk_0jmtmwkz8grugecy1bp7syh4e6wgg4os' \
--header 'Content-Type: application/json' \
--data-raw '{
  "start_date": "2026-01-14",
  "end_date": "2026-01-14",
  "page": 1,
  "page_size": 10
}'

---

8. Error Code Description (Example)

Code	Description
0	success
Non-zero	Parameter error / Authentication failure / System error

Common Error Scenarios

• Missing or invalid Authorization header
• Invalid date format or date range
• Invalid page or page_size parameters

---