送り方の説明

あなたのサービスから SNSチェキへ、売上・フォロワー数・再生数などの数字を送る方法です。送った数字は、あなたのダッシュボードにだけ表示されます。

1. キーを発行する

ダッシュボードでプロジェクトを開き、「つなぐ」の「キーを発行」を押します。キーは sc_ から始まる文字列で、表示されるのは発行した直後の1回だけです。送る側の環境変数（例：SNSCHEKI_API_KEY）に保存してください。コードやリポジトリには書かないでください。

キーはプロジェクトごとに別々です。そのキーで書けるのは、そのプロジェクトだけです。

2. 数字を送る

https://snscheki.com/api/v1/metrics に JSON を POST します。

curl -X POST https://snscheki.com/api/v1/metrics \
  -H "Authorization: Bearer $SNSCHEKI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"metrics":[
    {"metric":"followers","platform":"x","value":1234},
    {"metric":"revenue","platform":"stripe","value":9800,"unit":"jpy"},
    {"metric":"views","platform":"youtube","value":560}
  ]}'

• 同じ数字を同じ日にもう一度送ると、上書きになります。1日に何度送っても増えません。
• date（YYYY-MM-DD）を省くと、日本時間の今日として記録します。過去の日付を付ければ、過去の数字もまとめて送れます。
• 1回に送れるのは500件までです。
• User-Agent を必ず付けてください。空のままや、プログラム言語の初期値のままだと、403 で拒否されることがあります。

3. 数字の種類

ダッシュボードの一覧に出るのは、次の数字です。

ほかに mrr（月額課金の売上）、subscriptions（契約数）、users（会員数）、downloads（ダウンロード数）、likes、comments などがあります。一覧に無い数字も、英小文字と _ で名前を付けて送れば、プロジェクトの詳細画面にグラフが出ます。

4. 投稿ごとの数字を送る

動画やポストなど、投稿1つずつの数字は /api/v1/posts に送ります。externalId は投稿を見分けるID（動画のIDなど）です。

curl -X POST https://snscheki.com/api/v1/posts \
  -H "Authorization: Bearer $SNSCHEKI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"posts":[{
    "platform":"youtube","externalId":"abc123","title":"はじめての動画",
    "url":"https://youtu.be/abc123","publishedAt":"2026-10-01",
    "views":560,"likes":12,"comments":3
  }]}'

5. 失敗を知らせる

投稿や定期処理が失敗したときは /api/v1/events に送ると、ダッシュボードの「要確認」に出ます。直ったら同じ job 名で ok を送ると消えます。

curl -X POST https://snscheki.com/api/v1/events \
  -H "Authorization: Bearer $SNSCHEKI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"events":[{"job":"毎日の投稿","status":"fail","message":"アップロードに失敗"}]}'

status は ok（成功）／fail（失敗）／skip（見送り）のどれかです。

6. うまくいかないとき

キーが正しいかは GET /api/v1/whoami で確かめられます。