گزارش عملکرد کمپین | مستندات نجوا

گزارش تجمیعی یک اجرای کمپین را برمی‌گرداند: وضعیت اجرا، وضعیت تأیید کمپین و شمارندهٔ ارسال، تحویل، خطا، بلاک‌شده، پیش‌نمایش و کلیک. مقدار {id} همان execution_id است که هنگام ساخت کمپین دریافت کرده‌اید (نه campaign_id).

در صورت خطا، به بخش کدهای خطا مراجعه کنید.

احراز هویت

نوع احراز هویتتوکن BearerbearerAuth

کلید API را در هدر Authorization با پیشوند Bearer بفرستید:

``` Authorization: Bearer YOURAPIKEY ```

این روش برای «انبوه نظیر به نظیر»، «وب سرویس کمپین»، «هوشمند چند کاناله» و بارگذاری فایل به کار می‌رود. سرویس «تراکنشی» کلید را از مسیر URL می‌گیرد و هدری نمی‌خواهد.

هدر لازم

Authorization: Bearer YOUR_ACCESS_TOKEN

کلید خود را کجا پیدا کنم؟

اطلاعات ورود را از پنل کاربری خود بگیرید و توکن را فقط روی سرور و در یک متغیر محیطی نگه دارید؛ هرگز آن را در کد سمت کاربر قرار ندهید.

پارامترهای مسیر

نام	نوع	الزامی	توضیح
`id`*	integer	الزامی	شناسهٔ اجرای کمپین (`execution_id`) که از پاسخ ساخت کمپین گرفته می‌شود. نمونه`100`

پاسخ‌ها

ساختار پاسخ

نام	نوع	الزامی	توضیح
`return`	ApiStatus	اختیاری	وضعیت پاسخ. مقدار `status` با کد وضعیت HTTP پاسخ یکسان است.
`status`*	integer	الزامی	کد وضعیت — همان کد وضعیت HTTP پاسخ. نمونه`200`
`message`*	string	الزامی	پیام فارسی قابل نمایش به کاربر. نمونه`درخواست تایید شد.`
`entries`	CampaignReportResponse	اختیاری
`status`	string	اختیاری	وضعیت اجرای کمپین. نمونه`SCHEDULED`
`approval_status`	string	اختیاری	وضعیت تأیید کمپین. نمونه`APPROVED`
`reject_reason`	string	اختیاری	دلیل رد شدن؛ در صورت نبود، `null`. می‌تواند null باشد
`sent`	integer	اختیاری	تعداد ارسال‌شده. نمونه`100`
`delivered`	integer	اختیاری	تعداد رسیده به گیرنده. نمونه`80`
`failed`	integer	اختیاری	تعداد ناموفق. نمونه`5`
`blocked`	integer	اختیاری	تعداد بلاک‌شده. نمونه`2`
`preview`	integer	اختیاری	تعداد نمایش. نمونه`60`
`total_click`	integer	اختیاری	مجموع کلیک‌ها. نمونه`100`
`clicker`	integer	اختیاری	تعداد کاربران کلیک‌کننده. نمونه`30`

نمونهٔ پاسخ

{
  "return": {
    "status": 200,
    "message": "درخواست تایید شد."
  },
  "entries": {
    "status": "SCHEDULED",
    "approval_status": "APPROVED",
    "reject_reason": null,
    "sent": 100,
    "delivered": 80,
    "failed": 5,
    "blocked": 2,
    "preview": 60,
    "total_click": 100,
    "clicker": 30
  }
}

{ "return": { "status": 200, "message": "درخواست تایید شد." }, "entries": { "status": "SCHEDULED", "approval_status": "APPROVED", "reject_reason": null, "sent": 100, "delivered": 80, "failed": 5, "blocked": 2, "preview": 60, "total_click": 100, "clicker": 30 } }