> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scanova.io/llms.txt
> Use this file to discover all available pages before exploring further.

# الحصول على حملة التقييم النشطة

> GET /campaign/active/

يعيد حملة تقييم G2 النشطة حاليًا على مضيف **Management API** (‏`api.scanova.io`)، مصادَقًا عليها بمفتاح Management API الخام الخاص بك — راجع [النظرة العامة](/ar/api-reference/management-api/overview) إذا لم تُعِدَّ ذلك بعد.

```
GET https://api.scanova.io/campaign/active/
Authorization: 401f7ac837da42b97f613d789819ff93537bee6a
```

تُجري Scanova حملات دورية تشجّع العملاء الراضين على ترك تقييم على G2. يعيد هذا الطرف محتوى الحملة — `title` و`button_label` و`link`، بالإضافة إلى النافذة الزمنية التي تكون فيها نشطة — بحيث يمكن لأي تكامل عرض نفس الإشعار الذي تعرضه لوحة تحكم Scanova، إن أراد ذلك.

<RequestExample>
  ```bash cURL theme={null}
  curl "https://api.scanova.io/campaign/active/" \
    -H "Authorization: 401f7ac837da42b97f613d789819ff93537bee6a"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "id": 4,
    "name": "g2-q3-push",
    "start_date": "2026-07-01",
    "end_date": "2026-09-30",
    "title": "Enjoying Scanova? Leave us a review on G2",
    "button_label": "Write a review",
    "link": "https://www.g2.com/products/scanova/reviews",
    "is_active": true,
    "plans": [12, 14, 27]
  }
  ```
</ResponseExample>

## لا توجد حملة نشطة

لا توجد حملة قائمة دائمًا. يعني الرد `404` هنا هذا بالضبط — لا يوجد شيء لعرضه الآن، وليس خطأ. `plans` هي قائمة معرّفات الخطط التي تستهدفها هذه الحملة؛ الخطة التي لا توجد في هذه القائمة ببساطة لن ترى الحملة في لوحة تحكم Scanova، رغم أن هذا الطرف نفسه لا يُرشِّح حسب خطة المفتاح المستدعي.

## طرق ذات صلة

* [الحصول على حالة الإغلاق الخاصة بك للحملة النشطة](/ar/api-reference/management-api/campaign/user-log-status) — ما إذا كان هذا الحساب قد أغلقها بالفعل.
* [تسجيل أن النافذة المنبثقة قد عُرضت أو أُغلقت أو أُرسلت](/ar/api-reference/management-api/campaign/user-log-create) — تسجيل تفاعل معها.
* [نظرة عامة على Management API](/ar/api-reference/management-api/overview) — مخطط المصادقة وقواعد الحصة المطبّقة على هذا الطرف.


## OpenAPI

````yaml api-reference/openapi/management-api.json GET /campaign/active/
openapi: 3.1.0
info:
  title: Scanova Management API (v2)
  description: >-
    The complete Scanova Management API — every endpoint available at
    api.scanova.io (QR codes, folders, tags, leads, forms, analytics, plans,
    shared users & roles), plus the token-creation and usage-stats endpoints
    used to authenticate against it. Every path and request/response shape below
    was verified live against a real API key and the actual running backend
    (Phase 7, 2026-08-16) — not guessed from reading urls.py alone.
  version: 2.0.0
servers:
  - url: https://api.scanova.io
    description: Management API — QR/folder/tag/lead/form/analytics/plans endpoints
security:
  - apiKeyAuth: []
paths:
  /campaign/active/:
    get:
      summary: Get the active review campaign
      description: >-
        Returns the currently active G2 review-prompt campaign, if any — the
        banner text, button label, and link a client would render. Returns 404
        when no campaign is currently active; treat that as "show nothing", not
        an error.
      operationId: getManagedActiveCampaign
      responses:
        '200':
          description: The active campaign.
          content:
            application/json:
              example:
                id: 4
                name: g2-q3-push
                start_date: '2026-07-01'
                end_date: '2026-09-30'
                title: Enjoying Scanova? Leave us a review on G2
                button_label: Write a review
                link: https://www.g2.com/products/scanova/reviews
                is_active: true
                plans:
                  - 12
                  - 14
                  - 27
        '404':
          description: No campaign is currently active.
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Send your Management API key as the raw value of the Authorization
        header — no "Bearer " or "Token " prefix, and no other characters.
        Example: `Authorization: 401f7ac837da42b97f613d789819ff93537bee6a`. A
        header containing more than one space-separated part is rejected
        outright. Requests also require the request's Host header to be the
        management API host (e.g. api.scanova.io) — the same key sent to the
        regular API host will not authenticate.

````