Campaigns

Get a campaign

Changed on

Get a campaign with detailed metrics

get/campaign/{id}

Request

  • Base URL
    https://api.smallest.ai/atoms/v1
  • URL
    https://api.smallest.ai/atoms/v1/campaign/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the campaign

Response

Campaign details with metrics

statusboolean

Example response

{
  "status": true,
  "data": {
    "campaign": {
      "maxRetries": 3,
      "retryDelay": 15
    },
    "metrics": {
      "total_participants": 500,
      "contacts_called": 247,
      "contacts_connected": 150
    }
  }
}

Changes

  • d0c211a56a23Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      added the new failed enum value to the // response property for the response status

    • warning

      added the new processing enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      removed the scheduled_for_retry enum value from the // response property for the response status