HighLevel: Get campaign publishing progress

← Ad publishing operations · Get started

Operation gohighlevel.fb_get_campaign_publishing_progress

Provider route: GET /ad-publishing/facebook/campaigns/{campaignId}/publishing-progress. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["adPublishing"]["fbGetCampaignPublishingProgress"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.adPublishing.fbGetCampaignPublishingProgress(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.ad_publishing.fb_get_campaign_publishing_progress(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.campaignId	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Required within parent
query.isDraft	boolean	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get campaign publishing progress — response body

Referenced models: Get campaign publishing progress — response body

Schemas

Get campaign publishing progress — response body

Field	Type	Presence	Description and constraints
$	object	Root
campaignId	string	Required within parent	Campaign identifier
hasFailed	boolean	Required within parent	Whether publishing failed (Redis failed status or campaign FAILED)
isComplete	boolean	Required within parent	Whether publishing is finished (Redis complete/failed, processed >= total, or status is no longer PUBLISHING)
processed	JSON	Required within parent
processed (anyOf 1)	number	Alternative	Number of publish steps completed so far
processed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
publishingStatus	string	Required within parent	Current campaign publishing status in ad-publishing Known values: DRAFT, SCHEDULED, PUBLISHED, PUBLISHING, FAILED, IN_REVIEW, PAUSED, ARCHIVED, WITH_ISSUES, REJECTED
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total publish steps tracked in Redis (campaign + ad sets + ads)
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: gohighlevel.fb_get_campaign_publishing_progress. Catalog operation: fb-get-campaign-publishing-progress. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["adPublishing.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source