Bỏ qua tới nội dung

API dành cho nhà xuất bản

Đọc trang web, vùng quảng cáo, thống kê, thu nhập và số dư từ tập lệnh và công cụ của bạn. HTTPS và JSON thuần, xác thực bằng khoá API.

Bắt đầu trong 5 phút

Gọi yêu cầu xác thực đầu tiên, rồi đọc thống kê bảy ngày. Bạn cần tài khoản nhà xuất bản đang hoạt động và cURL trong cửa sổ dòng lệnh.

  1. Tạo khoá chỉ đọc

    Mở mục khoá API trong tài khoản, tạo khoá có quyền publisher:read rồi chép bí mật ngay khi được hiển thị. Thay giá trị mẫu bên dưới bằng khoá của bạn trên máy riêng.

    export AGIMONE_API_KEY='adk_replace_with_your_key'
    Tạo khoá API
  2. Kiểm tra tài khoản

    Phản hồi thành công là hồ sơ của bạn: kiểm tra id, role và publisher trước khi tiếp tục. Mã 401 nghĩa là khoá bị thiếu, không hợp lệ hoặc đã thu hồi.

    curl -fsS -H "Authorization: Bearer $AGIMONE_API_KEY" "${AGIMONE_API_BASE:-https://app.agimone.com}/v1/me"
  3. Đọc thống kê

    Chạy ví dụ đầy đủ này trong cùng cửa sổ dòng lệnh. Ví dụ chọn bảy ngày lịch gần nhất theo EST cố định (UTC−5), gồm hôm nay, và trả về rows, totals cùng currency: USD. Mảng rows rỗng có thể là bình thường với tài khoản mới.

    #!/usr/bin/env bash
    # GET /v1/stats: daily pops, revenue and eCPM for the last 7 calendar days (EST, fixed UTC-5).
    # Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE, AGIMONE_FROM, AGIMONE_TO.
    set -euo pipefail
    BASE="${AGIMONE_API_BASE:-https://app.agimone.com}"
    # Snapshot the EST day once; calendar arithmetic uses that date label.
    TODAY="$(TZ=Etc/GMT+5 date +%F)"
    # `date -v` is BSD/macOS, `date -d` is GNU/Linux.
    FROM="${AGIMONE_FROM:-$(date -u -j -v-6d -f '%Y-%m-%d' "$TODAY" +%F 2>/dev/null || date -u -d "$TODAY -6 days" +%F)}"
    TO="${AGIMONE_TO:-$TODAY}"
    curl -fsS -H "Authorization: Bearer $AGIMONE_API_KEY" \
      "$BASE/v1/stats?from=$FROM&to=$TO&group_by=date&metrics=pops,revenue,ecpm"
    echo

Xác thực

Gửi khoá API dưới dạng mã truy cập Bearer ở mọi yêu cầu. Khoá bắt đầu bằng adk_ và chỉ hiện một lần khi bạn tạo.

Tạo và thu hồi khoá trong tài khoản tại app.agimone.com/app/account/api-keys. Chỉ cấp cho khoá quyền tối thiểu cần dùng: publisher:read để đọc, publisher:write để đổi trang web và vùng quảng cáo.

Địa chỉ gốc: https://app.agimone.com. Phản hồi là JSON. Số tiền là chuỗi thập phân, đơn vị USD.

publisher:read
Đọc trang web, vùng quảng cáo, thống kê, thu nhập, số dư và các lần rút tiền của bạn. Bắt đầu bằng quyền này.
publisher:write
Thay đổi trang web, vùng quảng cáo hoặc thu hồi khoá. Chỉ thêm khi cần; cấp riêng publisher:read để đọc dữ liệu.

Giữ khoá trên máy chủ hoặc trong kho bí mật. Không đặt khoá trong mã chạy trên trình duyệt, kho mã công khai, URL hay nhật ký. Để thay khoá, tạo khoá mới, cập nhật tích hợp rồi thu hồi khoá cũ trong tài khoản. Thu hồi ngay nếu khoá bị lộ.

OAuth cho MCP

OAuth dùng để kết nối trợ lý AI qua MCP. Tài liệu REST này dùng khoá API; xem hướng dẫn MCP về ứng dụng hỗ trợ, cấp quyền tài khoản và thu hồi kết nối.

Kết nối qua MCP

Giới hạn tốc độ

Yêu cầu được đếm trong cửa sổ cố định 60 giây. Mỗi khoá API có bộ đếm riêng theo mã khoá; các phiên web cùng người dùng dùng chung bộ đếm. Thao tác công khai đếm theo địa chỉ IP. Tầng me dùng chung cho mọi phiên và khoá API của cùng người dùng.

TầngÁp dụng choYêu cầu mỗi phút
readCác thao tác GET, HEAD và OPTIONS còn lại120
writeThao tác POST, PUT, PATCH và DELETE20
statsGET /v1/stats và GET /v1/stats/subid30
publicĐường dẫn công khai, gồm tài liệu OpenAPI (theo IP)60
meGET và HEAD /v1/me (dùng chung theo người dùng)600

Header phản hồi

  • RateLimit-Limit: Số yêu cầu cho phép trong cửa sổ hiện tại.
  • RateLimit-Remaining: Số yêu cầu còn lại trong cửa sổ hiện tại.
  • RateLimit-Reset: Số giây tới hết cửa sổ.
  • Retry-After: Chỉ có ở 429: số giây cần chờ trước khi thử lại.

Vượt giới hạn sẽ nhận 429 kèm {"error":"rate_limited"}. Header có thể vắng khi bộ giới hạn tạm thời không sẵn sàng; khi đó yêu cầu vẫn được cho qua.

Lỗi

Phản hồi lỗi là JSON có mã error ổn định, ví dụ {"error":"unauthorized"}. Một số thao tác thêm message hoặc chi tiết có cấu trúc. Xử lý theo trạng thái HTTP và mã lỗi; không dùng thông điệp thô làm chữ giao diện đã dịch.

MãHTTPÝ nghĩa
unauthorized401Thiếu, sai hoặc đã thu hồi khoá API. Kiểm tra tiêu đề Authorization hoặc thay khoá.
forbidden403Khoá thiếu quyền cần có, nhà xuất bản chưa hoạt động hoặc tác nhân không được phép thực hiện thao tác. Kiểm tra trạng thái tài khoản và quyền trước khi thử lại.
rate_limited429Cửa sổ hiện tại đã đầy. Chờ số giây trong Retry-After trước khi thử lại; tránh vòng lặp gửi lại ngay.

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

Phân trang và kết quả lớn

Không có tham số page, offset hay cursor dùng chung. Danh sách trang web, vùng quảng cáo, lần rút tiền và khoá API trả về mảng. Chỉ gửi tham số được tài liệu của từng thao tác hỗ trợ.

Với /v1/stats, thu hẹp from/to hoặc thêm site_id, zone_id và bộ lọc được hỗ trợ. Phản hồi truncated: true nghĩa là một số dòng bị cắt; chia khoảng ngày hoặc lọc chi tiết hơn thay vì yêu cầu con trỏ trang kế tiếp.

Với /v1/stats/subid, limit chọn các kết quả đứng đầu: mặc định 100, tối đa 1000 cho JSON. Đây không phải phân trang. Khi truncated là true, các nhãn còn lại được gộp thành ~other; tổng vẫn bao gồm toàn bộ lựa chọn.

Ngày, giờ và tiền tệ

Trường thời gian, gồm giá trị hour trong JSON, dùng ISO 8601 theo UTC (ví dụ 2026-10-28T05:00:00Z). Ngày báo cáo theo EST, cố định UTC−5 quanh năm; không thay bằng America/New_York vì múi giờ đó đổi theo giờ mùa hè.

Ngày from và to là nhãn ngày báo cáo YYYY-MM-DD, tính cả hai đầu. Một ngày EST bắt đầu lúc 05:00:00Z và kết thúc ngay trước 05:00:00Z ngày sau. Giờ trong CSV hiển thị theo EST (UTC−5).

Thống kê cho phép tối đa 366 ngày tính cả hai đầu; nhóm theo giờ cho phép 31 ngày, thống kê theo sub-id cho phép 90 ngày. Chia khoảng lớn thành các ngày báo cáo không chồng lặp.

Số tiền là chuỗi thập phân, đơn vị USD. Giữ độ chính xác thập phân khi tính tiền. Trạng thái doanh thu là estimated, reported, final hoặc mixed; eCPM có thể là null khi không có lượt hiển thị hợp lệ. Doanh thu theo giờ có thể được phân bổ từ doanh thu ngày; kiểm tra hourly_revenue_allocated.

Ổn định và nhật ký thay đổi

API đánh phiên bản theo ngày của tài liệu (hiện tại: 2026-10). Trong /v1 chúng tôi chỉ thêm trường và thao tác. Việc bỏ một trường hoặc một thao tác được báo bằng tiêu đề phản hồi Deprecation và Sunset ít nhất 183 ngày (sáu tháng) trước khi xảy ra, kèm một mục trong nhật ký bên dưới.

Hãy coi trường lạ trong phản hồi là bình thường và bỏ qua.

Nhật ký thay đổi

2026-10

  • Thêm listSites: Phát hành công khai lần đầu
  • Thêm createSite: Phát hành công khai lần đầu
  • Thêm getSite: Phát hành công khai lần đầu
  • Thêm updateSite: Phát hành công khai lần đầu
  • Thêm listZones: Phát hành công khai lần đầu
  • Thêm listSiteZones: Phát hành công khai lần đầu
  • Thêm createZone: Phát hành công khai lần đầu
  • Thêm getZone: Phát hành công khai lần đầu
  • Thêm updateZone: Phát hành công khai lần đầu
  • Thêm getZoneCode: Phát hành công khai lần đầu
  • Thêm getStats: Phát hành công khai lần đầu
  • Thêm getEarnings: Phát hành công khai lần đầu
  • Thêm getBalance: Phát hành công khai lần đầu
  • Thêm listPayouts: Phát hành công khai lần đầu
  • Thêm getMe: Phát hành công khai lần đầu
  • Thêm whoAmI: Phát hành công khai lần đầu
  • Thêm listApiKeys: Phát hành công khai lần đầu
  • Thêm revokeApiKey: Phát hành công khai lần đầu
  • Thêm getOpenApiPublisher: Phát hành công khai lần đầu
  • Thêm getNotificationPrefs: Phát hành công khai lần đầu
  • Thêm listTelegramLinks: Đọc trạng thái liên kết Telegram, không hiện mã chat
  • Thêm getNotificationPrefs (report_hour): Giờ gửi báo cáo hằng ngày theo múi giờ tài khoản (0–23)

2026-10

  • Thêm getBalance (held): Khoản giữ đang hoạt động
  • Thêm getEarnings (adjustments[].source): Nguồn điều chỉnh từ đối soát hoặc khiếu nại
  • Thêm getEarnings (adjustments[].earnings_day_id): Mã dòng thu nhập để khiếu nại điều chỉnh
  • Thêm getIvtReport: Báo cáo IVT theo zone và ngày EST
  • Thêm getPayoutTerms: Điều khoản trả tiền công khai theo yêu cầu
  • Thêm listHolds: Khoản giữ có bằng chứng và mốc kết luận
  • Thêm listDisputes: Khiếu nại và hạn xử lý của publisher
  • Thêm getDispute: Chi tiết chuỗi tin nhắn khiếu nại
  • Thêm createDispute: Mở khiếu nại có giới hạn
  • Thêm createDisputeMessage: Gửi tin vào khiếu nại chưa kết luận

2026-10

  • Thêm getStatsAvailability: Các cách xem thống kê có sẵn cho cấu hình tài khoản, kèm ngày đầu có nhãn trình duyệt

2026-10

  • Thêm getSubidStats: Thống kê theo subid (sub1–sub3): lượt, doanh thu phân bổ và eCPM, JSON hoặc CSV
  • Thêm getSubidStatsAvailability: Cho biết thống kê theo subid đang bật hay tắt

2026-10

  • Thêm deleteSite: Xoá site và các zone của site (cần quyền manage)
  • Thêm deleteZone: Xoá zone (cần quyền manage)
  • changed updateZone: Đổi direct_url_enabled cần quyền Direct Link; X-Adnet-Confirm chỉ cần khi dừng zone hoặc tắt Smart Link
  • changed createZone: Nhận direct_url_enabled (bật cần quyền Direct Link)
  • changed createSite: Site được duyệt ngay khi tài khoản có quyền tự duyệt
  • changed updateSite: Đổi thể loại sau khi duyệt cần quyền manage
  • changed getMe: publisher.permissions liệt kê các quyền nâng cao của tài khoản

2026-10

  • Thêm patchSite: Đổi thể loại hoặc ghi chú site. Trả 202 kèm pending_category khi thay đổi cần duyệt; PUT /v1/sites/{id} theo cùng luật (202 thay cho 409 manage_not_allowed hoặc 400 site_kind_immutable)
  • Thêm getSite (pending_category): Thể loại đang chờ duyệt (null khi không có yêu cầu)
  • Thêm getSite (pending_category_at): Lúc gửi yêu cầu đổi thể loại
  • Thêm getSite (deleted_at): Thời điểm xoá của site đã xoá (null với site đang sống)
  • Thêm getSite (publisher_note): Ghi chú của bạn cho đội duyệt (tối đa 500 ký tự)
  • Thêm restoreSite: Khôi phục site đã xoá khi có quyền manage. GET nhận include=deleted. POST /v1/sites trả 200 khi khôi phục site của bạn. Xung đột dùng domain_exists, domain_taken hoặc domain_archived thay cho domain_deleted.

Các thao tác

Mỗi thao tác có một trang Markdown cho công cụ và mô hình ngôn ngữ.

Các ví dụ đọc AGIMONE_API_KEY (và tuỳ chọn AGIMONE_API_BASE) từ biến môi trường và in phản hồi JSON.

GET/v1/balance

Lấy số dư

Số dư hiện tại của publisher: `available` là số tiền có thể yêu cầu rút, `pending` là doanh thu ước tính (các ngày AGIMone chưa chốt; chưa rút được tới khi đã chốt), `held` là tổng khoản giữ đang hoạt động (đã trừ khỏi `available`), `requested` là số tiền trong các yêu cầu rút đang mở, `paid_total` là tổng đã trả, `min_payout` là mức rút tối thiểu. Mọi số tiền là chuỗi tiền tệ. Cùng số liệu với trường `balance` của GET /v1/earnings. Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

Không có tham số.

Phản hồi

{ available: string; held: string; min_payout: string; paid_total: string; pending: string; requested: string }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429

Ví dụ

cURL
#!/usr/bin/env bash
# GET /v1/balance: current balance (pending, available, requested, paid_total, min_payout).
# Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE.
set -euo pipefail
BASE="${AGIMONE_API_BASE:-https://app.agimone.com}"
curl -fsS -H "Authorization: Bearer $AGIMONE_API_KEY" "$BASE/v1/balance"
echo
Node.js
// GET /v1/balance: current balance (pending, available, requested, paid_total, min_payout). Node 18+, no dependencies.
// Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE.
const base = process.env.AGIMONE_API_BASE ?? 'https://app.agimone.com';

const res = await fetch(`${base}/v1/balance`, {
  headers: { Authorization: `Bearer ${process.env.AGIMONE_API_KEY}` },
});
if (!res.ok) {
  console.error(`HTTP ${res.status}: ${await res.text()}`);
  process.exit(1);
}
console.log(JSON.stringify(await res.json()));
PHP
<?php
// GET /v1/balance: current balance (pending, available, requested, paid_total, min_payout). PHP 8 with the curl extension, no other dependencies.
// Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE.
$base = getenv('AGIMONE_API_BASE') ?: 'https://app.agimone.com';

$ch = curl_init("$base/v1/balance");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('AGIMONE_API_KEY')],
    CURLOPT_TIMEOUT => 15,
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($body === false || $status >= 400) {
    fwrite(STDERR, "HTTP $status: " . ($body === false ? curl_error($ch) : $body) . "\n");
    exit(1);
}
curl_close($ch);
echo trim($body), "\n";
Python
# GET /v1/balance: current balance (pending, available, requested, paid_total, min_payout). Python 3.8+, standard library only.
# Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE.
import json
import os
import sys
import urllib.error
import urllib.request

base = os.environ.get("AGIMONE_API_BASE", "https://app.agimone.com")
req = urllib.request.Request(
    f"{base}/v1/balance",
    headers={"Authorization": f"Bearer {os.environ['AGIMONE_API_KEY']}"},
)
try:
    with urllib.request.urlopen(req, timeout=15) as res:
        print(json.dumps(json.load(res)))
except urllib.error.HTTPError as e:
    print(f"HTTP {e.code}: {e.read().decode()}", file=sys.stderr)
    sys.exit(1)

GET/v1/disputes

Liệt kê khiếu nại

Danh sách khiếu nại của nhà xuất bản, kèm trạng thái và hạn phản hồi đầu 48 giờ, hạn kết luận 7 ngày. Cần quyền `publisher:read`. Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

Không có tham số.

Phản hồi

{ amount_returned: string | null; first_response_at: string | null; first_response_due_at: string; id: integer; opened_at: string; overdue: boolean; resolution: "upheld" | "rejected" | "partial" | null; resolve_due_at: string; resolved_at: string | null; status: "open" | "answered" | "resolved"; subject_id: integer | null; subject_type: "hold" | "adjustment" | "ivt" | "zone_quality" | "payout" | "other" }[]

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429

POST/v1/disputes

Mở khiếu nại

Mở khiếu nại IVT, chất lượng vùng quảng cáo, khoản giữ, điều chỉnh, yêu cầu rút hoặc nội dung khác, với tin nhắn tối đa 5.000 ký tự Unicode. Tối đa 5 khiếu nại chưa kết luận; mỗi vùng quảng cáo có tối đa một khiếu nại chất lượng trong 24 giờ. Đối tượng phải thuộc nhà xuất bản. Cần quyền `publisher:write`; không ghi trong chế độ xem thay. Tầng giới hạn tốc độ: `write`.

Quyền
publisher:write
Tầng giới hạn tốc độ
write

Tham số

Không có tham số.

Nội dung yêu cầu

{ message: string; subject_id?: integer | null; subject_type: "hold" | "adjustment" | "ivt" | "zone_quality" | "payout" | "other" }

Phản hồi

{ amount_returned: string | null; first_response_at: string | null; first_response_due_at: string; id: integer; messages: { author_type: "publisher" | "admin"; body: string; created_at: string; id: integer }[]; opened_at: string; overdue: boolean; resolution: "upheld" | "rejected" | "partial" | null; resolve_due_at: string; resolved_at: string | null; status: "open" | "answered" | "resolved"; subject_id: integer | null; subject_type: "hold" | "adjustment" | "ivt" | "zone_quality" | "payout" | "other" }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 400
  • 401
  • 403
  • 404
  • 409
  • 429

GET/v1/disputes/{id}

Lấy chi tiết khiếu nại

Chi tiết và chuỗi tin nhắn của khiếu nại thuộc nhà xuất bản đang đọc. Cần quyền `publisher:read`. Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó

Phản hồi

{ amount_returned: string | null; first_response_at: string | null; first_response_due_at: string; id: integer; messages: { author_type: "publisher" | "admin"; body: string; created_at: string; id: integer }[]; opened_at: string; overdue: boolean; resolution: "upheld" | "rejected" | "partial" | null; resolve_due_at: string; resolved_at: string | null; status: "open" | "answered" | "resolved"; subject_id: integer | null; subject_type: "hold" | "adjustment" | "ivt" | "zone_quality" | "payout" | "other" }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 404
  • 429

POST/v1/disputes/{id}/messages

Gửi tin nhắn khiếu nại

Gửi thêm tin nhắn tối đa 5.000 ký tự Unicode vào khiếu nại của nhà xuất bản chưa kết luận. Khiếu nại đã được trả lời chuyển lại thành đang mở khi nhà xuất bản viết tiếp. Cần quyền `publisher:write`; không ghi trong chế độ xem thay. Tầng giới hạn tốc độ: `write`.

Quyền
publisher:write
Tầng giới hạn tốc độ
write

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó

Nội dung yêu cầu

{ message: string }

Phản hồi

{ amount_returned: string | null; first_response_at: string | null; first_response_due_at: string; id: integer; messages: { author_type: "publisher" | "admin"; body: string; created_at: string; id: integer }[]; opened_at: string; overdue: boolean; resolution: "upheld" | "rejected" | "partial" | null; resolve_due_at: string; resolved_at: string | null; status: "open" | "answered" | "resolved"; subject_id: integer | null; subject_type: "hold" | "adjustment" | "ivt" | "zone_quality" | "payout" | "other" }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 400
  • 401
  • 403
  • 404
  • 409
  • 429

GET/v1/earnings

Lấy thu nhập

Thu nhập theo ngày trong một khoảng ngày, kèm số dư hiện tại. Điều chỉnh gồm `source` (đối soát hoặc khiếu nại) và `earnings_day_id` để chọn đối tượng khiếu nại. Ngày thu nhập theo EST cố định (UTC−5). Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

TênVị tríKiểuBắt buộc
fromquerystringcó
toquerystringcó

Phản hồi

{ adjustments: { amount: string; detected_on: string; earnings_day_id: integer; for_date: string; source: "network" | "dispute" }[]; balance: { available: string; held: string; min_payout: string; paid_total: string; pending: string; requested: string }; count_basis?: "valid" | "legacy" | "mixed"; currency: "USD"; days: { adjustment: string; count_basis?: "valid" | "legacy" | "mixed"; date: string; pops: integer; revenue: string; status?: "estimated" | "reported" | "final" | "mixed" }[]; estimated_at?: string | null; forecast_basis_version?: "forecast-basis-v1"; forecast_generation?: string; forecast_updated_at?: string | null; measurement_definition?: { complete: boolean; includes_direct: boolean; includes_legacy: boolean; tag_valid_after_ms: integer[] }; measurement_generation?: string; measurement_status?: "ok" | "stale" | "updating"; measurement_updated_at?: string | null; money_basis_version?: string; money_generation?: string; updated_at?: string | null }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429
  • 503

GET/v1/holds

Liệt kê khoản giữ

Tối đa 200 khoản giữ của nhà xuất bản, mới nhất trước, gồm số tiền, lý do, bằng chứng, ngày có thể thu và ngày tự nhả sau 30 ngày. Khoản giữ đang hoạt động đã trừ khỏi số dư khả dụng. Cần quyền `publisher:read`. Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

Không có tham số.

Phản hồi

{ amount: string; auto_release_at: string; created_at: string; date_from: string; date_to: string; decided_at: string | null; decision_note: string | null; evidence: string; evidence_data: { cap: string; ivt: object | null; network_report_ref: string | null; reported_deduction: string | null; revenue_publisher: string; revshare_pct: number; suspect_pct: number | null }; forfeit_not_before: string; id: integer; original_amount: string; reason_code: "ivt_suspected" | "network_clawback_pending" | "policy_violation"; status: "active" | "released" | "forfeited"; zone_id: integer | null; zone_name: string | null }[]

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429

GET/v1/me

Lấy hồ sơ của tôi

Hồ sơ của người dùng (và nhà xuất bản) đang đăng nhập. Cần tác nhân là người dùng (khoá API của người dùng hoặc phiên web). Tầng giới hạn tốc độ: `me`. Giới hạn 600 yêu cầu mỗi 60 giây, dùng chung cho các phiên và khoá API của cùng người dùng.

Quyền
mọi khoá hoặc phiên
Tầng giới hạn tốc độ
me
Markdown
get-me.md

Tham số

Không có tham số.

Phản hồi

{ email: string; id: integer; locale: "en" | "vi" | "es" | "pt" | "fr" | "id" | "ru" | "zh" | "ar"; mfa_enabled: boolean; publisher: { display_name: string; id: integer; min_payout: string; payout_details_masked: string | null; payout_method: "paypal" | "usdt" | "bank" | null; payout_method_pending: { effective_at: string; masked: string; method: "paypal" | "usdt" | "bank"; requested_at: string } | null; permissions: { auto_approve_sites: boolean; direct_link: boolean; manage: boolean }; revshare_pct: number; status: "active" | "pending" | "suspended" } | null; role: "admin" | "publisher" | "advertiser"; security_notice: { at: string; kind: "mfa_enabled" | "mfa_disabled" | "mfa_reset_by_admin" | "recovery_regenerated" | "recovery_used" | "password_changed" | "login_new_device" | "session_revoked" | "payout_method_requested" | "payout_method_applied" | "payout_method_cancelled" | "telegram_linked" | "telegram_unlinked" | "telegram_payout_enabled" | "telegram_payout_disabled" } | null; timezone: string; view_as: { display_name: string; publisher_id: integer } | null }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429

GET/v1/me/api-keys

Liệt kê khoá API

Liệt kê các khoá API đang hoạt động của nhà xuất bản (khoá bí mật không bao giờ được trả lại). Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

Không có tham số.

Phản hồi

{ created_at: string; id: integer; last_used_at: string | null; name: string; scopes: ("publisher:read" | "publisher:write" | "admin:read" | "admin:write" | "infra:read" | "infra:write" | "adv:read" | "adv:write" | "scan:work" | "dsp0:review")[] }[]

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429

DELETE/v1/me/api-keys/{id}

Thu hồi khoá API

Thu hồi một khoá API, ví dụ khoá bị lộ. Cần quyền `publisher:write` (khoá API hoặc phiên web); không dùng được trong chế độ xem thay. Tầng giới hạn tốc độ: `write`.

Quyền
publisher:write
Tầng giới hạn tốc độ
write

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó

Phản hồi

any

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 404
  • 429

GET/v1/notifications/prefs

Lấy tuỳ chọn thông báo

Những sự kiện thông báo đang bật trên từng kênh. Chỉ đổi được trên web (người đăng nhập). Trường `report_hour` cho biết giờ gửi báo cáo hằng ngày theo múi giờ tài khoản (0–23). Chỉ hiển thị kênh Telegram khi trợ lý tự động đã bật. Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

Không có tham số.

Phản hồi

{ items: { channel: "email" | "telegram" | "webhook" | "webpush"; enabled: boolean; event_type: "payout.upcoming" | "payout.status_changed" | "hold.created" | "hold.decided" | "dispute.replied" | "kyc.status_changed" | "zone.quality_changed" | "ivt.threshold_exceeded" | "zone.traffic_stopped" | "zone.traffic_resumed" | "day.finalized" | "report.daily" | "site.status_changed" | "referral.credited" | "support.replied" | "webhook.endpoint_disabled" | "account.security" | "ping"; locked: boolean }[]; report_hour?: integer }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429

GET/v1/openapi/publisher.json

Lấy tài liệu OpenAPI

Tài liệu OpenAPI 3 của API này (chỉ các thao tác dành cho nhà xuất bản). Không cần xác thực. Tầng giới hạn tốc độ: `public` (60 yêu cầu/phút cho mỗi IP). Được lưu trong bộ nhớ đệm 5 phút.

Tầng giới hạn tốc độ
public

Tham số

Không có tham số.

Phản hồi

{  }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 429

GET/v1/payouts

Liệt kê các lần rút tiền

Liệt kê các yêu cầu rút tiền của nhà xuất bản và trạng thái của chúng. Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

Không có tham số.

Phản hồi

{ amount: string; decided_at: string | null; id: integer; method: "paypal" | "usdt" | "bank"; notes: string | null; paid_at: string | null; requested_at: string; status: "requested" | "approved" | "paid" | "rejected"; tx_ref: string | null }[]

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429

GET/v1/public/payout-terms

Lấy điều khoản trả tiền công khai

Lịch trả theo yêu cầu, duyệt trong 2 ngày làm việc; số tối thiểu và tỷ lệ chia sẻ đọc từ mặc định đang thực thi, phương thức nhận tiền (USDT) và phiên bản chính sách IVT. Không cần xác thực. Tầng giới hạn tốc độ: `public` (60 yêu cầu/phút/IP). lưu trong bộ nhớ đệm 5 phút.

Tầng giới hạn tốc độ
public

Tham số

Không có tham số.

Phản hồi

{ generated_at: string; ivt_policy: { effective_from: string; status: "draft" | "approved"; version: string }; methods: "usdt"[]; minimum_payout: string; revshare_default_pct: number; schedule: { approval_business_days: integer | null; mode: "manual" | "net7" }; upcoming_changes: { effective_from: string; summary: object }[] }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 429

GET/v1/quality/ivt

Lấy báo cáo IVT

Số lượt yêu cầu, hợp lệ và bị lọc theo vùng quảng cáo, ngày EST cố định (UTC−5), kèm lý do IVT. Khoảng ngày gồm hai đầu, tối đa 92 ngày. vùng quảng cáo phải thuộc nhà xuất bản đang đọc. Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

TênVị tríKiểuBắt buộc
fromquerystringcó
toquerystringcó
zone_idqueryintegerkhông

Phản hồi

{ rows: { by_reason: object; capped: integer; date: string; demand_as_of: string | null; demand_ivt_amount: string | null; filtered: integer; final: boolean; ivt_rate_pre: number | null; level: "ok" | "watch" | "strict" | "limited" | "paused_quality"; paused: integer; requests: integer; sent: integer; zone_id: integer }[] }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 400
  • 401
  • 403
  • 404
  • 429

GET/v1/sites

Liệt kê trang web

Liệt kê các trang web chưa bị xoá của nhà xuất bản. Dùng `include=deleted` để lấy cả các trang web đã xoá. Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

TênVị tríKiểuBắt buộc
includequery"deleted"không

Phản hồi

{ category: "mainstream" | "adult" | "network"; created_at: string; deleted_at: string | null; domain: string; id: integer; notes: string | null; pending_category: "mainstream" | "adult" | "network" | null; pending_category_at: string | null; publisher_note: string | null; status: "pending" | "approved" | "rejected"; zones_count: integer }[]

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429

POST/v1/sites

Tạo trang web

Đăng ký trang web mới (201). Nếu có quyền `manage`, thêm lại tên miền của trang web bạn đã xoá sẽ khôi phục trang web với cùng mã định danh, giữ nguyên trạng thái và áp dụng thể loại đã chọn (200). Khi trả 409, `reason` là `domain_exists` nếu tên miền đã thuộc trang web chưa bị xoá của bạn, `domain_taken` nếu nhà xuất bản khác đang giữ tên miền, hoặc `domain_archived` nếu bạn thiếu quyền khôi phục trang web đã xoá của mình. Cần quyền `publisher:write` (khoá API hoặc phiên web); không dùng được trong chế độ xem thay. Tầng giới hạn tốc độ: `write`.

Quyền
publisher:write
Tầng giới hạn tốc độ
write

Tham số

Không có tham số.

Nội dung yêu cầu

{ category: "mainstream" | "adult" | "network"; domain: string }

Phản hồi

{ category: "mainstream" | "adult" | "network"; created_at: string; deleted_at: string | null; domain: string; id: integer; notes: string | null; pending_category: "mainstream" | "adult" | "network" | null; pending_category_at: string | null; publisher_note: string | null; status: "pending" | "approved" | "rejected"; zones_count: integer }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 400
  • 401
  • 403
  • 409
  • 429

DELETE/v1/sites/{id}

Xoá trang web

Xoá một trang web cùng mọi vùng quảng cáo của nó. Cần quyền manage trên tài khoản của bạn (nhờ hỗ trợ bật); nếu không, trả 403 với reason manage_not_allowed. Với khoá API, gửi header X-Adnet-Confirm: true. Lưu lượng dừng trong vài giây; số liệu và thu nhập cũ được giữ lại. Thêm lại tên miền hoặc gọi `POST /v1/sites/{id}/restore` để khôi phục trang web. Cần quyền `publisher:write` (khoá API hoặc phiên web); không dùng được trong chế độ xem thay. Tầng giới hạn tốc độ: `write`.

Quyền
publisher:write
Tầng giới hạn tốc độ
write

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó
x-adnet-confirmheaderstringkhông

Phản hồi

any

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 404
  • 428
  • 429

GET/v1/sites/{id}

Lấy một trang web

Trả về một trang web của nhà xuất bản. Dùng `include=deleted` để truy xuất cả trang web đã xoá của bạn. Trả 404 nếu không tìm được trang web mà bạn có quyền truy xuất. Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read
Markdown
get-site.md

Tham số

TênVị tríKiểuBắt buộc
includequery"deleted"không
idpathintegercó

Phản hồi

{ category: "mainstream" | "adult" | "network"; created_at: string; deleted_at: string | null; domain: string; id: integer; notes: string | null; pending_category: "mainstream" | "adult" | "network" | null; pending_category_at: string | null; publisher_note: string | null; status: "pending" | "approved" | "rejected"; zones_count: integer }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 404
  • 429

PATCH/v1/sites/{id}

Cập nhật một phần trang web

Gửi ít nhất một trường trong `category` (`mainstream`, `adult` hoặc `network`) và `notes`. Ghi chú cho đội duyệt dài tối đa 500 ký tự và được trả về trong `publisher_note`. Gửi `null` hoặc chuỗi rỗng để xoá ghi chú. Trả 200 khi cập nhật hoàn tất. Một số thay đổi thể loại trên trang web đã duyệt cần xét duyệt. Phản hồi 202 ghi thể loại được yêu cầu trong `pending_category`, còn trang web tiếp tục dùng `category` hiện tại cho đến khi duyệt xong. Gửi thể loại hiện tại để huỷ yêu cầu đang chờ. Cần quyền `publisher:write` (khoá API hoặc phiên web); không dùng được trong chế độ xem thay. Tầng giới hạn tốc độ: `write`.

Quyền
publisher:write
Tầng giới hạn tốc độ
write

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó

Nội dung yêu cầu

{ category?: "mainstream" | "adult" | "network"; notes?: string | null }

Phản hồi

{ category: "mainstream" | "adult" | "network"; created_at: string; deleted_at: string | null; domain: string; id: integer; notes: string | null; pending_category: "mainstream" | "adult" | "network" | null; pending_category_at: string | null; publisher_note: string | null; status: "pending" | "approved" | "rejected"; zones_count: integer }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 400
  • 401
  • 403
  • 404
  • 409
  • 429

Ví dụ

cURL
#!/usr/bin/env bash
# Request mainstream for a site. HTTP 202 means it keeps its current category while the request is reviewed.
# Needs AGIMONE_API_KEY, AGIMONE_SITE_ID, curl and jq. Optional AGIMONE_API_BASE overrides the API URL.
set -euo pipefail
BASE="${AGIMONE_API_BASE:-https://app.agimone.com}"
SITE_ID="${AGIMONE_SITE_ID:?Set AGIMONE_SITE_ID to the site ID}"
curl -fsS -X PATCH -H "Authorization: Bearer $AGIMONE_API_KEY" -H 'Content-Type: application/json' \
  --data '{"category":"mainstream"}' "$BASE/v1/sites/$SITE_ID" | jq -c '{category, pending_category}'
Node.js
// Request mainstream for a site. HTTP 202 means it keeps its current category while the request is reviewed.
// Needs AGIMONE_API_KEY, AGIMONE_SITE_ID and Node 18+. Optional AGIMONE_API_BASE overrides the API URL.
const base = process.env.AGIMONE_API_BASE ?? 'https://app.agimone.com';
const siteId = process.env.AGIMONE_SITE_ID;
if (!siteId) {
  console.error('Set AGIMONE_SITE_ID to the site ID.');
  process.exit(1);
}

const res = await fetch(`${base}/v1/sites/${siteId}`, {
  method: 'PATCH',
  headers: { Authorization: `Bearer ${process.env.AGIMONE_API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ category: 'mainstream' }),
});
if (!res.ok) {
  console.error(`HTTP ${res.status}: ${await res.text()}`);
  process.exit(1);
}
const { category, pending_category } = await res.json();
console.log(JSON.stringify({ category, pending_category }));
PHP
<?php
// Request mainstream for a site. HTTP 202 means it keeps its current category while the request is reviewed.
// Needs AGIMONE_API_KEY, AGIMONE_SITE_ID and PHP 8 with cURL. Optional AGIMONE_API_BASE overrides the API URL.
$base = getenv('AGIMONE_API_BASE') ?: 'https://app.agimone.com';
$siteId = getenv('AGIMONE_SITE_ID');
if (!$siteId) {
    fwrite(STDERR, "Set AGIMONE_SITE_ID to the site ID.\n");
    exit(1);
}

$ch = curl_init("$base/v1/sites/$siteId");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('AGIMONE_API_KEY'), 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['category' => 'mainstream']),
    CURLOPT_TIMEOUT => 15,
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($body === false || $status >= 400) {
    fwrite(STDERR, "HTTP $status: " . ($body === false ? curl_error($ch) : $body) . "\n");
    exit(1);
}
curl_close($ch);
$site = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
echo json_encode(['category' => $site['category'], 'pending_category' => $site['pending_category']]), "\n";
Python
# Request mainstream for a site. HTTP 202 means it keeps its current category while the request is reviewed.
# Needs AGIMONE_API_KEY, AGIMONE_SITE_ID and Python 3.8+. Optional AGIMONE_API_BASE overrides the API URL.
import json
import os
import sys
import urllib.error
import urllib.request

base = os.environ.get("AGIMONE_API_BASE", "https://app.agimone.com")
site_id = os.environ.get("AGIMONE_SITE_ID")
if not site_id:
    sys.exit("Set AGIMONE_SITE_ID to the site ID.")

req = urllib.request.Request(
    f"{base}/v1/sites/{site_id}",
    data=json.dumps({"category": "mainstream"}).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['AGIMONE_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="PATCH",
)
try:
    with urllib.request.urlopen(req, timeout=15) as res:
        site = json.load(res)
        print(json.dumps({"category": site["category"], "pending_category": site["pending_category"]}))
except urllib.error.HTTPError as e:
    print(f"HTTP {e.code}: {e.read().decode()}", file=sys.stderr)
    sys.exit(1)

PUT/v1/sites/{id}

Cập nhật trang web

Đổi thể loại trang web sang `mainstream`, `adult` hoặc `network`. Ưu tiên dùng `PATCH /v1/sites/{id}`. Trả 200 khi cập nhật hoàn tất. Một số thay đổi thể loại trên trang web đã duyệt cần xét duyệt. Phản hồi 202 ghi thể loại được yêu cầu trong `pending_category`, còn trang web tiếp tục dùng `category` hiện tại cho đến khi duyệt xong. Gửi thể loại hiện tại để huỷ yêu cầu đang chờ. Cần quyền `publisher:write` (khoá API hoặc phiên web); không dùng được trong chế độ xem thay. Tầng giới hạn tốc độ: `write`.

Quyền
publisher:write
Tầng giới hạn tốc độ
write

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó

Nội dung yêu cầu

{ category: "mainstream" | "adult" | "network" }

Phản hồi

{ category: "mainstream" | "adult" | "network"; created_at: string; deleted_at: string | null; domain: string; id: integer; notes: string | null; pending_category: "mainstream" | "adult" | "network" | null; pending_category_at: string | null; publisher_note: string | null; status: "pending" | "approved" | "rejected"; zones_count: integer }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 400
  • 401
  • 403
  • 404
  • 409
  • 429

POST/v1/sites/{id}/restore

Khôi phục trang web

Khôi phục trang web đã xoá của bạn và các vùng quảng cáo bị xoá cùng lượt. Các vùng được khôi phục ở trạng thái tạm dừng. Nếu trang web chưa bị xoá, trả về dữ liệu hiện tại. Cần quyền `manage`. Trả 409 với `reason` là `domain_taken` nếu tên miền đang được sử dụng. Cần quyền `publisher:write` (khoá API hoặc phiên web); không dùng được trong chế độ xem thay. Tầng giới hạn tốc độ: `write`.

Quyền
publisher:write
Tầng giới hạn tốc độ
write

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó

Phản hồi

{ category: "mainstream" | "adult" | "network"; created_at: string; deleted_at: string | null; domain: string; id: integer; notes: string | null; pending_category: "mainstream" | "adult" | "network" | null; pending_category_at: string | null; publisher_note: string | null; status: "pending" | "approved" | "rejected"; zones_count: integer }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 404
  • 409
  • 429

GET/v1/sites/{id}/zones

Liệt kê vùng quảng cáo của một trang web

Liệt kê các vùng quảng cáo của một trang web. Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó

Phản hồi

{ adblock_rate: number | null; category: "mainstream" | "adult"; category_source: "site" | "zone"; created_at: string; direct_url_enabled: boolean; freq: { cap_count: integer; cap_window_s: integer; delay_s: integer; min_interval_s: integer; per_page: integer | null; preset: "light" | "balanced" | "strong" | "per_page" | "custom"; repeat_after_s?: 0 | integer }; freq_cap_count: integer; freq_cap_hours: integer; id: integer; last_load_at: string | null; last_request_at: string | null; loads_24h: integer; name: string; requests_24h: integer; site_domain: string; site_id: integer; status: "active" | "paused"; tag_state: "never" | "stale" | "live"; via: "tag" | "smart_link" | "both" | null }[]

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 404
  • 429

POST/v1/sites/{id}/zones

Tạo vùng quảng cáo

Tạo một vùng quảng cáo trong một trang web. Cần quyền `publisher:write` (khoá API hoặc phiên web); không dùng được trong chế độ xem thay. Tầng giới hạn tốc độ: `write`.

Quyền
publisher:write
Tầng giới hạn tốc độ
write

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó

Nội dung yêu cầu

{ category?: "mainstream" | "adult"; direct_url_enabled?: boolean; freq?: { cap_count?: integer; cap_window_s?: integer; delay_s?: integer; min_interval_s?: integer; per_page?: integer | null; preset: "light" | "balanced" | "strong" | "per_page" | "custom"; repeat_after_s?: 0 | integer }; freq_cap_count?: integer; freq_cap_hours?: integer; name: string }

Phản hồi

{ adblock_rate: number | null; category: "mainstream" | "adult"; category_source: "site" | "zone"; created_at: string; direct_url_enabled: boolean; freq: { cap_count: integer; cap_window_s: integer; delay_s: integer; min_interval_s: integer; per_page: integer | null; preset: "light" | "balanced" | "strong" | "per_page" | "custom"; repeat_after_s?: 0 | integer }; freq_cap_count: integer; freq_cap_hours: integer; id: integer; last_load_at: string | null; last_request_at: string | null; loads_24h: integer; name: string; requests_24h: integer; site_domain: string; site_id: integer; status: "active" | "paused"; tag_state: "never" | "stale" | "live"; via: "tag" | "smart_link" | "both" | null }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 400
  • 401
  • 403
  • 404
  • 409
  • 429

GET/v1/stats

Lấy thống kê

Số lượt hiển thị, doanh thu và eCPM của nhà xuất bản, nhóm theo ngày (`date`), giờ (`hour`), trang web (`site`), vùng quảng cáo (`zone`), quốc gia (`country`), thiết bị (`device`), hệ điều hành (`os`), trình duyệt (`browser`) hoặc tên miền trang (`page_domain`); trả JSON hoặc CSV. Bộ lọc `browser` nhận khoá trình duyệt chuẩn; doanh thu theo trình duyệt được phân bổ theo tỷ lệ lượt. Nếu cách xem theo trình duyệt chưa có hoặc đang tắt (xem `/v1/stats/availability`), yêu cầu có `group_by=browser` hoặc `browser` trả 400 `breakdown_unavailable` trước khi truy vấn thống kê, cho cả JSON và CSV. Nhóm hoặc lọc theo page_domain chỉ dùng được khi đo lường đã bật: trước đó trả 400 `page_domain_unavailable`, và JSON có `page_domain_available`. Khi `group_by` có `hour`, khoảng ngày (gồm cả hai đầu, ngày nghiệp vụ EST (UTC−5) cố định) tối đa 31 ngày, nếu không sẽ trả 400 `hour_range`; doanh thu theo giờ của ngày đã chốt là phần phân bổ từ doanh thu theo ngày (phản hồi có `hourly_revenue_allocated: true`), không phải số đo theo từng giờ; giờ của ngày chưa chốt là số ước tính. Giờ trong JSON là ISO UTC; giờ trong CSV hiển thị EST (UTC−5). Mỗi dòng có `status` (`estimated` = ước tính, `reported` = đã báo cáo, `final` = đã chốt, `mixed` = kết hợp nhiều trạng thái) và phản hồi có `updated_at` (lần ước tính mới nhất, null khi chưa có). Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `stats`.

Quyền
publisher:read
Tầng giới hạn tốc độ
stats
Markdown
get-stats.md

Tham số

TênVị tríKiểuBắt buộc
fromquerystringcó
toquerystringcó
group_byquery("date" | "hour" | "site" | "zone" | "country" | "device" | "os" | "browser" | "page_domain")[]không
metricsquery("pops" | "revenue" | "ecpm")[]không
site_idqueryintegerkhông
zone_idqueryintegerkhông
countryquerystringkhông
browserquery"chrome" | "safari" | "firefox" | "edge" | "samsung_internet" | "opera" | "uc_browser" | "yandex" | "other"không
page_domainquerystringkhông
formatquery"json" | "csv"không

Phản hồi

{ browser_missing_days?: string[]; count_basis?: "valid" | "legacy" | "mixed"; currency: "USD"; data_as_of?: string | null; estimated_from: string | null; forecast_basis_version?: "forecast-basis-v1"; forecast_generation?: string; forecast_updated_at?: string | null; hourly_revenue_allocated?: true; measurement_definition?: { complete: boolean; includes_direct: boolean; includes_legacy: boolean; tag_valid_after_ms: integer[] }; measurement_generation?: string; measurement_status?: "ok" | "stale" | "updating"; measurement_updated_at?: string | null; money_basis_version?: string; money_generation?: string; page_domain_available?: boolean; rows: { browser?: "chrome" | "safari" | "firefox" | "edge" | "samsung_internet" | "opera" | "uc_browser" | "yandex" | "other"; country?: string; date?: string; device?: string; ecpm?: string | null; hour?: string; os?: string; page_domain?: string | null; pops?: integer; publisher_id?: integer; revenue?: string; site_deleted?: true; site_domain?: string; site_id?: integer; status?: "estimated" | "reported" | "final" | "mixed"; zone_deleted?: true; zone_id?: integer; zone_name?: string }[]; totals: { ecpm: string | null; pops: integer; revenue: string; status?: "estimated" | "reported" | "final" | "mixed" }; truncated?: boolean; updated_at?: string | null }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 400
  • 401
  • 403
  • 404
  • 429
  • 503

Ví dụ

cURL
#!/usr/bin/env bash
# GET /v1/stats: daily pops, revenue and eCPM for the last 7 calendar days (EST, fixed UTC-5).
# Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE, AGIMONE_FROM, AGIMONE_TO.
set -euo pipefail
BASE="${AGIMONE_API_BASE:-https://app.agimone.com}"
# Snapshot the EST day once; calendar arithmetic uses that date label.
TODAY="$(TZ=Etc/GMT+5 date +%F)"
# `date -v` is BSD/macOS, `date -d` is GNU/Linux.
FROM="${AGIMONE_FROM:-$(date -u -j -v-6d -f '%Y-%m-%d' "$TODAY" +%F 2>/dev/null || date -u -d "$TODAY -6 days" +%F)}"
TO="${AGIMONE_TO:-$TODAY}"
curl -fsS -H "Authorization: Bearer $AGIMONE_API_KEY" \
  "$BASE/v1/stats?from=$FROM&to=$TO&group_by=date&metrics=pops,revenue,ecpm"
echo
Node.js
// GET /v1/stats: daily pops, revenue and eCPM for the last 7 calendar days (EST, fixed UTC-5). Node 18+, no dependencies.
// Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE, AGIMONE_FROM, AGIMONE_TO.
const base = process.env.AGIMONE_API_BASE ?? 'https://app.agimone.com';
const parts = new Intl.DateTimeFormat('en-US', { timeZone: 'Etc/GMT+5', year: 'numeric', month: '2-digit', day: '2-digit' }).formatToParts(new Date());
const part = (type) => parts.find((p) => p.type === type).value;
const today = `${part('year')}-${part('month')}-${part('day')}`;
const day = (offset) => new Date(Date.parse(`${today}T00:00:00Z`) + offset * 86_400_000).toISOString().slice(0, 10);
const query = new URLSearchParams({
  from: process.env.AGIMONE_FROM ?? day(-6),
  to: process.env.AGIMONE_TO ?? today,
  group_by: 'date',
  metrics: 'pops,revenue,ecpm',
});

const res = await fetch(`${base}/v1/stats?${query}`, {
  headers: { Authorization: `Bearer ${process.env.AGIMONE_API_KEY}` },
});
if (!res.ok) {
  console.error(`HTTP ${res.status}: ${await res.text()}`);
  process.exit(1);
}
console.log(JSON.stringify(await res.json()));
PHP
<?php
// GET /v1/stats: daily pops, revenue and eCPM for the last 7 calendar days (EST, fixed UTC-5). PHP 8 with the curl extension, no other dependencies.
// Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE, AGIMONE_FROM, AGIMONE_TO.
$base = getenv('AGIMONE_API_BASE') ?: 'https://app.agimone.com';
$today = new DateTimeImmutable('now', new DateTimeZone('Etc/GMT+5'));
$query = http_build_query([
    'from' => getenv('AGIMONE_FROM') ?: $today->modify('-6 days')->format('Y-m-d'),
    'to' => getenv('AGIMONE_TO') ?: $today->format('Y-m-d'),
    'group_by' => 'date',
    'metrics' => 'pops,revenue,ecpm',
]);

$ch = curl_init("$base/v1/stats?$query");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('AGIMONE_API_KEY')],
    CURLOPT_TIMEOUT => 15,
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($body === false || $status >= 400) {
    fwrite(STDERR, "HTTP $status: " . ($body === false ? curl_error($ch) : $body) . "\n");
    exit(1);
}
curl_close($ch);
echo trim($body), "\n";
Python
# GET /v1/stats: daily pops, revenue and eCPM for the last 7 calendar days (EST, fixed UTC-5). Python 3.8+, standard library only.
# Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE, AGIMONE_FROM, AGIMONE_TO.
import json
import os
import sys
import urllib.error
import urllib.parse
import urllib.request
from datetime import datetime, timedelta, timezone

base = os.environ.get("AGIMONE_API_BASE", "https://app.agimone.com")
# Fixed UTC-5 is Etc/GMT+5; Python 3.8 needs no zoneinfo/tzdata dependency.
today = datetime.now(timezone(timedelta(hours=-5))).date()
query = urllib.parse.urlencode({
    "from": os.environ.get("AGIMONE_FROM", str(today - timedelta(days=6))),
    "to": os.environ.get("AGIMONE_TO", str(today)),
    "group_by": "date",
    "metrics": "pops,revenue,ecpm",
})
req = urllib.request.Request(
    f"{base}/v1/stats?{query}",
    headers={"Authorization": f"Bearer {os.environ['AGIMONE_API_KEY']}"},
)
try:
    with urllib.request.urlopen(req, timeout=15) as res:
        print(json.dumps(json.load(res)))
except urllib.error.HTTPError as e:
    print(f"HTTP {e.code}: {e.read().decode()}", file=sys.stderr)
    sys.exit(1)

GET/v1/stats/availability

Lấy các cách xem thống kê có sẵn

Trả về `browser_available`: `true` khi có thể nhóm hoặc lọc thống kê theo trình duyệt, `false` khi cách xem này chưa có cho cấu hình tài khoản. Trả thêm `browser_enabled`: `false` khi cách xem theo trình duyệt đang tắt (nên ẩn lựa chọn) và `browser_data_since`: ngày EST (YYYY-MM-DD) đầu tiên mà mọi giờ đều có nhãn trình duyệt, hoặc null khi chưa rõ; lượt trước đó gộp vào `other`. Kiểm tra trước khi chọn trình duyệt. Nếu cách xem chưa có, yêu cầu thống kê có `group_by=browser` hoặc bộ lọc `browser` trả 400 với `error: breakdown_unavailable` và `breakdown: browser`, áp dụng cho cả JSON và CSV. Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

Không có tham số.

Phản hồi

{ browser_available: boolean; browser_data_since?: string | null; browser_enabled?: boolean }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429

GET/v1/stats/subid

Lấy thống kê theo subid

Số lượt hiển thị, doanh thu và eCPM của nhà xuất bản, nhóm theo sub1, sub2 và sub3, tối đa 90 ngày; trả JSON hoặc CSV. Doanh thu theo subid là phần phân bổ từ doanh thu `/v1/stats` của từng vùng quảng cáo và quốc gia theo tỉ lệ số lượt hiển thị, không phải số đo riêng (`revenue_allocated` luôn là `true`); tổng của phản hồi bằng tổng `/v1/stats` cùng khoảng ngày và bộ lọc. Các dòng sắp theo doanh thu; phần vượt `limit` được gộp vào một dòng có subid là `~other`. Subid `null` nghĩa là lượt không mang subid. Mỗi dòng có `status` (`estimated` = ước tính, `reported` = đã báo cáo, `final` = đã chốt, `mixed` = kết hợp nhiều trạng thái). Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `stats`.

Quyền
publisher:read
Tầng giới hạn tốc độ
stats

Tham số

TênVị tríKiểuBắt buộc
fromquerystringcó
toquerystringcó
group_byquery("sub1" | "sub2" | "sub3")[]không
site_idqueryintegerkhông
zone_idqueryintegerkhông
sub1querystringkhông
sub2querystringkhông
sub3querystringkhông
limitqueryintegerkhông
formatquery"json" | "csv"không

Phản hồi

{ count_basis?: "valid" | "legacy" | "mixed"; currency: "USD"; estimated_from: string | null; forecast_basis_version?: "forecast-basis-v1"; forecast_generation?: string; forecast_updated_at?: string | null; measurement_definition?: { complete: boolean; includes_direct: boolean; includes_legacy: boolean; tag_valid_after_ms: integer[] }; measurement_generation?: string; measurement_status?: "ok" | "stale" | "updating"; measurement_updated_at?: string | null; money_basis_version?: string; money_generation?: string; revenue_allocated: true; rows: { ecpm: string | null; pops: integer; revenue: string; status?: "estimated" | "reported" | "final" | "mixed"; sub1?: string | null; sub2?: string | null; sub3?: string | null }[]; totals: { ecpm: string | null; pops: integer; revenue: string; status?: "estimated" | "reported" | "final" | "mixed" }; truncated?: boolean; updated_at?: string | null }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 400
  • 401
  • 403
  • 404
  • 429
  • 503

GET/v1/stats/subid/availability

Kiểm tra thống kê theo subid có bật không

Cho biết thống kê theo subid đang bật hay tắt. Cần quyền `publisher:read` (khoá API hoặc phiên web).

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

Không có tham số.

Phản hồi

{ enabled: boolean }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429

GET/v1/whoami

Tôi là ai

Tác nhân đứng sau khoá API hoặc phiên hiện tại, kèm các quyền của nó. Mọi tác nhân đã xác thực đều gọi được. Tầng giới hạn tốc độ: `read`.

Quyền
mọi khoá hoặc phiên
Tầng giới hạn tốc độ
read
Markdown
who-am-i.md

Tham số

Không có tham số.

Phản hồi

{ actor_id: integer | null; actor_type: string; api_key_id: integer | null; scopes: ("publisher:read" | "publisher:write" | "admin:read" | "admin:write" | "infra:read" | "infra:write" | "adv:read" | "adv:write" | "scan:work" | "dsp0:review")[] }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429

GET/v1/zones

Liệt kê vùng quảng cáo

Liệt kê mọi vùng quảng cáo của nhà xuất bản, có thể lọc theo site_id. Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

TênVị tríKiểuBắt buộc
site_idqueryintegerkhông

Phản hồi

{ adblock_rate: number | null; category: "mainstream" | "adult"; category_source: "site" | "zone"; created_at: string; direct_url_enabled: boolean; freq: { cap_count: integer; cap_window_s: integer; delay_s: integer; min_interval_s: integer; per_page: integer | null; preset: "light" | "balanced" | "strong" | "per_page" | "custom"; repeat_after_s?: 0 | integer }; freq_cap_count: integer; freq_cap_hours: integer; id: integer; last_load_at: string | null; last_request_at: string | null; loads_24h: integer; name: string; requests_24h: integer; site_domain: string; site_id: integer; status: "active" | "paused"; tag_state: "never" | "stale" | "live"; via: "tag" | "smart_link" | "both" | null }[]

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 429

DELETE/v1/zones/{id}

Xoá vùng quảng cáo

Xoá một vùng quảng cáo. Cần quyền manage trên tài khoản của bạn (nhờ hỗ trợ bật); nếu không, trả 403 với reason manage_not_allowed. Với khoá API, gửi header X-Adnet-Confirm: true. Lưu lượng dừng trong vài giây; số liệu và thu nhập cũ được giữ lại. Liên hệ hỗ trợ để khôi phục vùng quảng cáo. Cần quyền `publisher:write` (khoá API hoặc phiên web); không dùng được trong chế độ xem thay. Tầng giới hạn tốc độ: `write`.

Quyền
publisher:write
Tầng giới hạn tốc độ
write

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó
x-adnet-confirmheaderstringkhông

Phản hồi

any

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 404
  • 428
  • 429

GET/v1/zones/{id}

Lấy một vùng quảng cáo

Trả về một vùng quảng cáo thuộc nhà xuất bản. Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read
Markdown
get-zone.md

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó

Phản hồi

{ adblock_rate: number | null; category: "mainstream" | "adult"; category_source: "site" | "zone"; created_at: string; direct_url_enabled: boolean; freq: { cap_count: integer; cap_window_s: integer; delay_s: integer; min_interval_s: integer; per_page: integer | null; preset: "light" | "balanced" | "strong" | "per_page" | "custom"; repeat_after_s?: 0 | integer }; freq_cap_count: integer; freq_cap_hours: integer; id: integer; last_load_at: string | null; last_request_at: string | null; loads_24h: integer; name: string; requests_24h: integer; site_domain: string; site_id: integer; status: "active" | "paused"; tag_state: "never" | "stale" | "live"; via: "tag" | "smart_link" | "both" | null }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 404
  • 429

PUT/v1/zones/{id}

Cập nhật vùng quảng cáo

Cập nhật các trường của một vùng quảng cáo thuộc nhà xuất bản. Cần quyền `publisher:write` (khoá API hoặc phiên web); không dùng được trong chế độ xem thay. Tầng giới hạn tốc độ: `write`. Đổi tên và đổi tần suất không cần xác nhận. Với khoá API, tạm dừng vùng đang chạy hoặc tắt Smart Link của vùng cần header `X-Adnet-Confirm: true` (nếu không, trả 428). Đổi `direct_url_enabled` cần quyền Direct Link (403 `direct_link_not_allowed`). Sau khi trang web được duyệt, vùng quảng cáo thuộc trang web loại `network` có thể đổi từ `mainstream` sang `adult`. Đổi từ `adult` sang `mainstream` cần quyền `manage` (409 `manage_not_allowed` nếu thiếu quyền).

Quyền
publisher:write
Tầng giới hạn tốc độ
write

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó
x-adnet-confirmheaderstringkhông

Nội dung yêu cầu

{ category?: "mainstream" | "adult"; direct_url_enabled?: boolean; freq?: { cap_count?: integer; cap_window_s?: integer; delay_s?: integer; min_interval_s?: integer; per_page?: integer | null; preset: "light" | "balanced" | "strong" | "per_page" | "custom"; repeat_after_s?: 0 | integer }; freq_cap_count?: integer; freq_cap_hours?: integer; name?: string; status?: "active" | "paused" }

Phản hồi

{ adblock_rate: number | null; category: "mainstream" | "adult"; category_source: "site" | "zone"; created_at: string; direct_url_enabled: boolean; freq: { cap_count: integer; cap_window_s: integer; delay_s: integer; min_interval_s: integer; per_page: integer | null; preset: "light" | "balanced" | "strong" | "per_page" | "custom"; repeat_after_s?: 0 | integer }; freq_cap_count: integer; freq_cap_hours: integer; id: integer; last_load_at: string | null; last_request_at: string | null; loads_24h: integer; name: string; requests_24h: integer; site_domain: string; site_id: integer; status: "active" | "paused"; tag_state: "never" | "stale" | "live"; via: "tag" | "smart_link" | "both" | null }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 400
  • 401
  • 403
  • 404
  • 409
  • 428
  • 429

GET/v1/zones/{id}/code

Lấy mã nhúng của vùng quảng cáo

Trả về đoạn mã nhúng của một vùng quảng cáo. Cần quyền `publisher:read` (khoá API hoặc phiên web). Tầng giới hạn tốc độ: `read`.

Quyền
publisher:read
Tầng giới hạn tốc độ
read

Tham số

TênVị tríKiểuBắt buộc
idpathintegercó

Phản hồi

{ direct_url: string | null; loader: string; tag: { adblock_rate: number | null; last_load_at: string | null; last_request_at: string | null; loads_24h: integer; requests_24h: integer; state: "never" | "stale" | "live"; via: "tag" | "smart_link" | "both" | null } }

Lỗi của thao tác

Phần tham chiếu của từng thao tác liệt kê các trạng thái HTTP khác. Xem lược đồ phản hồi trong OpenAPI để biết chính xác mã lỗi và trường dữ liệu.

  • 401
  • 403
  • 404
  • 429

Chỉ trên web

Các thao tác này không thuộc API công khai. Chúng chỉ có trong ứng dụng web khi đã đăng nhập, vì liên quan tới tiền hoặc cài đặt bảo mật.

  • POST /v1/payouts
    Yêu cầu rút tiền. Gọi bằng khoá API sẽ nhận 403 human_required.
  • PUT /v1/me/payout-method
    Đổi nơi nhận tiền. Chỉ trên web.
  • PUT /v1/notifications/prefs
    Kênh thông báo, gồm cảnh báo bảo mật. Chỉ trên web để khoá bị lộ không tắt được cảnh báo.
  • PUT /v1/me/password
    Đổi mật khẩu. Chỉ trên web.
  • POST /v1/me/api-keys
    Tạo khoá API. Chỉ trên web; khoá có thể liệt kê và thu hồi khoá nhưng không tạo được khoá.
  • PUT /v1/me
    Không thuộc API công khai.