#Data Open API

Use an API Key to query visits and installs by promotion link or app from your own server, either as a total for a date range or broken down by day. This makes it easy to feed ROIBest data into your own BI, reporting or campaign systems.

#Quick start

1. Sign in to the ROIBest dashboard with your main account, click your avatar in the top-right corner → Open API → Generate API Key, and complete email verification.
2. The full API Key is shown only once, right after it is generated. Copy or download it immediately and store it securely on your server.
3. Send your first request from your server (replace the ID and Key in the example with your own):

curl -s 'https://openapi.roibest.com/open/v1/stats?promote_url_id=6347317793&start_date=2026-10-01&end_date=2026-10-07&group_by=day' \
  -H 'X-Api-Key: rbk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

#Authentication

Include your API Key in the header of every request:

X-Api-Key: rbk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

• The API Key is accepted only in the request header. A Key placed in URL parameters or the request body is treated as missing.
• Only the main account can generate and manage API Keys, and each main account has exactly one active Key at a time.
• After you click Regenerate in the dashboard, the old Key stops working immediately. Get your server configuration ready to switch before you regenerate.

#Rate limit

You can send up to 10 requests per minute. Requests beyond the limit receive HTTP 429; wait a moment before trying again.

#Query statistics

GET https://openapi.roibest.com/open/v1/stats

#Request parameters

All parameters are passed as URL query parameters.

Query rules:

• Provide exactly one of promote_url_id and app_id.
• All dates are in UTC+0. For example, 2026-10-01 covers 2026-10-01 00:00:00 to 23:59:59 UTC.
• If both dates are omitted, today is queried. If only one is provided, only that day is queried.
• The end date cannot be later than today (UTC+0).
• A single request can cover at most 30 days (start and end dates included).
• Only data from the last 90 days is available: the start date cannot be more than 90 days before today. For example, if today (UTC+0) is November 6, the earliest date you can query is August 8.
• You can only query promotion links and apps under your own account. Deleted or hidden ones can still be queried and are flagged by the deleted and hidden fields in the response.

#Response fields

#Example: range total

GET /open/v1/stats?promote_url_id=6347317793&start_date=2026-10-01&end_date=2026-10-02

{
  "code": 0,
  "msg": "success",
  "request_id": "9f1c2e7a4b3d4c6e8a0b1c2d3e4f5a6b",
  "data": {
    "app_id": null,
    "promote_url_id": "6347317793",
    "deleted": false,
    "hidden": false,
    "timezone": "UTC",
    "metrics": ["visit", "install"],
    "start_date": "2026-10-01",
    "end_date": "2026-10-02",
    "total": { "visit": 180, "install": 21 }
  }
}

#Example: daily breakdown

GET /open/v1/stats?app_id=1024&start_date=2026-10-01&end_date=2026-10-03&group_by=day

{
  "code": 0,
  "msg": "success",
  "request_id": "0a1b2c3d4e5f60718293a4b5c6d7e8f9",
  "data": {
    "app_id": "1024",
    "promote_url_id": null,
    "deleted": false,
    "hidden": false,
    "timezone": "UTC",
    "metrics": ["visit", "install"],
    "start_date": "2026-10-01",
    "end_date": "2026-10-03",
    "rows": [
      { "date": "2026-10-01", "visit": 100, "install": 12 },
      { "date": "2026-10-02", "visit": 80, "install": 9 },
      { "date": "2026-10-03", "visit": 0, "install": 0 }
    ]
  }
}

#Metrics

• Both metrics exclude traffic identified as invalid by the system.
• Days are split by UTC+0. Today's figures are cumulative up to the time of the query.

#Error codes

On failure, both the HTTP status code and a business code are returned (except for HTTP 429). Example response:

{ "code": 40003, "msg": "date range must not exceed 30 days", "request_id": "9f1c2e7a4b3d4c6e8a0b1c2d3e4f5a6b" }