Get Campaign

Returns the full details of a single campaign by its ID, including budget, frequency cap, drug and diagnosis associations, management fee configuration, and custom fields.

Endpoint

GET

https://lifeapi.pulsepoint.com/RestApi/v2/account/{accountId}/campaigns/{campaignId}

Path Parameters

Name	Data Type	Required	Notes
accountId	integer	yes	The ID of the account that owns the campaign
campaignId	integer	yes	The ID of the campaign to retrieve

Sample Request

GET https://lifeapi.pulsepoint.com/RestApi/v2/account/559145/campaigns/345678

Response Field List

Name	Data Type	Notes
id	string	Unique campaign identifier
name	string	Campaign name
type	string	Campaign type (e.g. `Regular`)
description	string	Campaign description
status	string	Campaign status (e.g. `Incomplete`, `Pending Approval`, `Active`)
budgetCap	number	Total budget cap for the campaign. `null` if not set
budgetStatus	string	Budget status (e.g. `Pending Approval`). `null` if not set
createdAt	string	ISO 8601 timestamp of when the campaign was created
updatedAt	string	ISO 8601 timestamp of when the campaign was last updated
createdBy	string	ID of the user who created the campaign
updatedBy	string	ID of the user who last updated the campaign
advertiser	object	Advertiser associated with this campaign
advertiser.id	string	Advertiser ID
advertiser.name	string	Advertiser name
drug	object	Primary drug associated with this campaign. `{}` if not set
drug.productNdc	string	NDC code of the drug. `null` if not set
drug.brandName	string	Brand name of the drug. `null` if not set
marketBasketDrug	object	Market basket drug associated with this campaign. `{}` if not set
marketBasketDrug.productNdc	string	NDC code of the market basket drug. `null` if not set
marketBasketDrug.brandName	string	Brand name of the market basket drug. `null` if not set
diagnosis	object	Diagnosis associated with this campaign. `{}` if not set
diagnosis.icd10Code	string	ICD-10 code for the diagnosis. `null` if not set
diagnosis.shortDescription	string	Short description of the diagnosis. `null` if not set
frequencyCap	object	Frequency cap configuration for the campaign
frequencyCap.applyFrequencyCap	boolean	Whether a frequency cap is applied
frequencyCap.times	number	Number of times an ad can be shown within the period. `null` if not set
frequencyCap.period	string	Period unit for frequency cap (e.g. `day`, `week`, `month`). `null` if not set
frequencyCap.hoursValue	number	Number of hours for a custom frequency period. `null` if not set
frequencyCap.crossDevice	string	Cross-device frequency cap setting (e.g. `Per Device`). `null` if not set
managementFee	object	Management fee configuration
managementFee.type	string	Fee type (e.g. `percentage_and_cpm`). `null` if not set
managementFee.percentage	number	Fee percentage. `null` if not set
managementFee.cpm	number	CPM fee amount. `null` if not set
customFields	array	List of custom field key-value pairs. `[]` if none set
customFields.fieldName	string	Custom field name
customFields.fieldValue	string	Custom field value
creativeSeparation	object	Creative separation configuration
creativeSeparation.enabled	boolean	Whether creative separation is enabled
creativeSeparation.campaignIds	array	List of campaign IDs from which creatives are separated. `[]` if none set

Sample Response

{
  "id": "345678",
  "advertiser": {
    "id": "adv_987654321",
    "name": "Example Advertiser Inc."
  },
  "name": "Q1 2024 Brand Awareness Campaign",
  "type": "Regular",
  "drug": {
    "productNdc": "drug_456789",
    "brandName": "Example Drug Name"
  },
  "marketBasketDrug": {
    "productNdc": "mbd_789456",
    "brandName": "Market Basket Drug Name"
  },
  "diagnosis": {
    "icd10Code": "A234",
    "shortDescription": "Example Diagnosis"
  },
  "budgetCap": 50000.00,
  "frequencyCap": {
    "applyFrequencyCap": true,
    "times": 5,
    "period": "day",
    "hoursValue": 2,
    "crossDevice": "Per Device"
  },
  "description": "Campaign description with details about objectives and strategy",
  "budgetStatus": "Pending Approval",
  "managementFee": {
    "type": "percentage_and_cpm",
    "percentage": 25,
    "cpm": 2
  },
  "customFields": [
    {
      "fieldName": "Line Item Custom Field REST",
      "fieldValue": "line item field value"
    }
  ],
  "creativeSeparation": {
    "enabled": false,
    "campaignIds": []
  },
  "status": "Incomplete",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-20T14:45:00Z",
  "createdBy": "user_789012",
  "updatedBy": "user_789012"
}

Errors

HTTP Status	Error	Description
400	Bad Request	Invalid query parameters
403	Forbidden	Insufficient permissions to access this campaign
404	Not Found	Campaign not found for the given account and campaign ID