Get a campaign + stats

GET https://emails.routeon.io/api/v1/campaigns/{id}

Parameters

id string<uuid> required path

Responses

200 OK
404 Resource not found within tenant scope

Example response · 200

{
    "status": "success",
    "http_code": 0,
    "payload": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "type": "blast",
        "status": "draft",
        "domain_id": "00000000-0000-0000-0000-000000000000",
        "template_id": "00000000-0000-0000-0000-000000000000",
        "template_version": 0,
        "audience": {
            "include": [
                {
                    "kind": "list",
                    "id": "00000000-0000-0000-0000-000000000000"
                }
            ],
            "exclude": [
                {
                    "kind": "list",
                    "id": "00000000-0000-0000-0000-000000000000"
                }
            ]
        },
        "schedule_at": "2024-01-01T00:00:00Z",
        "sender_profile_id": "00000000-0000-0000-0000-000000000000",
        "from_name": "string",
        "reply_to": "user@example.com",
        "stats": {
            "sent": 0,
            "delivered": 0,
            "opened": 0,
            "clicked": 0,
            "bounced": 0,
            "complained": 0,
            "failed": 0
        },
        "recipient_count": 0,
        "throttle_per_hour": 0,
        "launched_at": "2024-01-01T00:00:00Z",
        "completed_at": "2024-01-01T00:00:00Z",
        "pause_reason": "string",
        "created_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-01T00:00:00Z"
    },
    "meta": []
}

Example response · 404

{
    "status": "error",
    "http_code": 0,
    "payload": [],
    "meta": {
        "reason": "VALIDATION_ERROR",
        "validation_error": [
            {
                "field": "string",
                "message": "string"
            }
        ],
        "details": []
    }
}