MeetROAS Customer API

1. Quickstart

Traffic buyer: Want your AI assistant to check ad performance?

1. Go to Dashboard /account/api 's "API" tab to create a Key
2. The complete Key is shown only once; immediately store it in an environment variable securely (e.g. read -rs MEETROAS_API_KEY then export MEETROAS_API_KEY, a password manager, or CI secrets)
3. Copy the following command and run it directly; the shell expands the variable automatically

curl https://open.meetroas.com/v1/me \
  -H "Authorization: Bearer $MEETROAS_API_KEY"

Developer: Need to integrate into your own service or script? Continue reading the REST API Reference below.

2. Authentication

Obtain API Key

• In Dashboard /account/api 's "API" tab, create a new key
• The complete Key is shown only once at creation, format: mrp_<id>_<secret>
• Valid for 30/90/365 days, no permanent Keys
• Maximum 5 valid Keys per creator, 20 per account

Usage

All REST requests require the Authorization header:

Authorization: Bearer mrp_<id>_<secret>

Scopes

Choose scopes explicitly when creating a Key; existing keys and the default selection remain read-only:

• apps:read — Read app list
• campaigns:read — Read campaigns
• performance:read — Read performance data (including placement insights)
• apps:write — Create and edit Apps; also requires apps:read
• campaigns:write — Create and edit Campaigns; also requires apps:read and campaigns:read

Effective permissions = Key scopes ∩ creator's current role. Takes up to 10 seconds after the creator is disabled or demoted, revocation is immediate.

3. Quota and limits

Quota enforces both quota units and request counts independently. Each plan has both per-minute and daily limits:

Unit costs

So the Free plan allows up to 3 placement insight calls per minute, 100 per day; general reads are 30 per minute, 1,000 per day.

Response headers

• RateLimit-Limit — units limit per minute
• RateLimit-Remaining — remaining units in rolling 60-second window
• RateLimit-Reset — seconds until the oldest entry leaves the window
• X-MeetROAS-Daily-Remaining — remaining units today
• X-MeetROAS-Api-Version — 1

Other limits

• GET /v1/apps does not paginate (plan limit is 30 Apps maximum)
• Placement insights return up to 500 groups, remainder aggregated in other; 5000-row/CSV mode not available
• CORS disabled, browser-side JavaScript cannot call directly

4. REST API Reference

Base URL: https://open.meetroas.com/v1

GET /v1/me

Required scopes: any valid Key · Quota units: 1

Get current API Key information, account plan, and remaining quota.

curl "https://open.meetroas.com/v1/me" \
  -H "Authorization: Bearer $MEETROAS_API_KEY"

{
  "ok": true,
  "data": {
    "key": {
      "id": "a7f3k29d1mq4x8bz",
      "label": "My API Key",
      "scopes": ["apps:read", "campaigns:read", "performance:read"],
      "expiresAt": "2027-01-01T00:00:00Z"
    },
    "account": {
      "id": "acc_9f2c4d61-8b3a-4e57-9d10-2f6b8c1e4a77",
      "plan": "pro"
    },
    "creator": {
      "role": "admin"
    },
    "quota": {
      "perMinute": {
        "limit": 120,
        "remaining": 118,
        "resetInSeconds": 42
      },
      "daily": {
        "limit": 20000,
        "remaining": 15234
      }
    }
  }
}

GET /v1/apps

Required scopes: apps:read · Quota units: 1

Get all Apps in the account.

curl "https://open.meetroas.com/v1/apps" \
  -H "Authorization: Bearer $MEETROAS_API_KEY"

{
  "ok": true,
  "data": {
    "items": [
      {
        "id": "brand_4a7c9e21b8d35f60a1c4e7b209d63f8a",
        "slug": "my-game",
        "name": "My Awesome Game",
        "iconUrl": "https://assets.meetroas.com/icons/my-game.png",
        "trafficSource": {
          "id": "trafficstars",
          "label": "TrafficStars"
        },
        "campaignCount": 5,
        "reportingTimezone": "Asia/Taipei"
      }
    ]
  }
}

GET /v1/apps/{appSlug}/campaigns

Required scopes: apps:read + campaigns:read · Quota units: 1

Get all campaigns in the specified App.

curl "https://open.meetroas.com/v1/apps/my-game/campaigns" \
  -H "Authorization: Bearer $MEETROAS_API_KEY"

{
  "ok": true,
  "data": {
    "app": {
      "id": "brand_4a7c9e21b8d35f60a1c4e7b209d63f8a",
      "slug": "my-game",
      "name": "My Awesome Game"
    },
    "items": [
      {
        "id": "brand:brand_4a7c9e21b8d35f60a1c4e7b209d63f8a",
        "kind": "primary",
        "label": "My Awesome Game",
        "host": "my-game.meetroas.com",
        "enabled": true,
        "objective": "pwa_install",
        "trafficSource": {
          "id": "trafficstars",
          "label": "TrafficStars"
        }
      }
    ]
  }
}

GET /v1/apps/{appSlug}/campaigns/{campaignId}/placement-insights

Required scopes: apps:read + campaigns:read + performance:read · Quota units: 10

Get placement insights and recommendations for the specified campaign.

Query parameters:

• range: today | 7d | 30d (default: 7d)
• dimension: placement | subPlacement | creative | upstreamCampaign | country | environment (default: placement)

curl "https://open.meetroas.com/v1/apps/my-game/campaigns/brand:brand_9f2c41ab7d0e4c518a63b2d7e04f19c5/placement-insights?range=7d&dimension=placement" \
  -H "Authorization: Bearer $MEETROAS_API_KEY"

Response contains campaigns, totals, rows (up to 500), other, and advice (block, whitelist, bids, targeting), see https://open.meetroas.com/openapi.json

Create and edit Apps and Campaigns

All writes require Idempotency-Key (8–128 characters); PATCH also requires the If-Match ETag from the matching /editor GET. A stale version returns 412.

• POST /v1/apps、PATCH /v1/apps/{appSlug}：JSON with the Dashboard App editor's content, primary, destination, objective and media sections.
• POST /v1/apps/{appSlug}/campaigns、PATCH /v1/apps/{appSlug}/campaigns/{campaignId}：Multipart form with every Dashboard Campaign editor field; JSON {enabled:boolean} changes a secondary Campaign's status.
• GET /v1/apps/{appSlug}/editor、GET /v1/apps/{appSlug}/campaigns/{campaignId}/editor：Get complete editable data and ETag. The primary Campaign uses App editor fields and apps:write.
• POST /v1/media/staging：Stage icon, screenshots, hero or video, then use its receipt in the media field. On create, target is new-app:{Idempotency-Key} or new-page:{appId}:{Idempotency-Key}.

Request fields and JSON shapes are in https://open.meetroas.com/openapi.json

5. Errors and retries

GET requests can be retried; keep the same Idempotency-Key for writes, and reload /editor and ETag after an edit conflict.