> ## Documentation Index > Fetch the complete documentation index at: https://bavlio.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get a campaign's outreach progress > Returns how many of the campaign's leads are in each state of its sequence, and the next steps due, soonest first. ## OpenAPI ```json { "openapi": "3.2.0", "info": { "title": "Bavlio API", "version": "1.0.0" }, "paths": { "/campaigns/{id}/outreach": { "get": { "tags": [ "Campaigns" ], "operationId": "campaigns.getCampaignOutreach", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "description": "Campaign id." }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "campaign_id": { "type": "string" }, "sequence_version": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Latest sequence version; null when the campaign has none yet." }, "enrollments": { "type": "object", "properties": { "active": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Leads working through the steps.", "allOf": [ { "minimum": 0 } ] }, "waiting": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Leads waiting on a condition or on a message's approval.", "allOf": [ { "minimum": 0 } ] }, "paused": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Leads held while the campaign is paused or archived or has no connected LinkedIn sender.", "allOf": [ { "minimum": 0 } ] }, "stopped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Leads stopped because they replied or opted out.", "allOf": [ { "minimum": 0 } ] }, "completed": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Leads done with the sequence.", "allOf": [ { "minimum": 0 } ] } }, "required": [ "active", "waiting", "paused", "stopped", "completed" ], "additionalProperties": false, "description": "How many of the campaign's leads are in each sequence state." }, "next_actions": { "type": "array", "items": { "type": "object", "properties": { "lead_id": { "type": "string" }, "lead_name": { "type": "string" }, "lead_stage": { "type": "string", "enum": [ "found", "visited", "liked", "emailed", "invited", "accepted", "messaged", "replied", "meeting" ], "description": "Furthest stage the lead has reached." }, "step_id": { "type": "string", "description": "Sequence step the lead is on." }, "kind": { "type": "string", "enum": [ "visit_profile", "like_post", "invite", "message", "email", "wait", "branch" ], "description": "Kind of that step." }, "state": { "type": "string", "enum": [ "active", "waiting", "paused", "stopped_replied", "completed" ], "description": "active, or waiting on a condition or on a message's approval." }, "at": { "type": "string", "description": "When Bavlio next works on the lead (ISO 8601)." } }, "required": [ "lead_id", "lead_name", "lead_stage", "step_id", "kind", "state", "at" ], "additionalProperties": false }, "description": "Up to 10 leads with the next steps due, soonest first." } }, "required": [ "campaign_id", "sequence_version", "enrollments", "next_actions" ], "additionalProperties": false } } } }, "400": { "description": "RequestInvalidBody", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestInvalidBodyEncoded" } } } }, "401": { "description": "AuthMissing | AuthInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuthMissingEncoded" }, { "$ref": "#/components/schemas/AuthInvalidEncoded" } ] } } } }, "404": { "description": "WorkspaceNotFound | CampaignNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/WorkspaceNotFoundEncoded" }, { "$ref": "#/components/schemas/CampaignNotFoundEncoded" } ] } } } } }, "description": "Returns how many of the campaign's leads are in each state of its sequence, and the next steps due, soonest first.", "summary": "Get a campaign's outreach progress" } } }, "components": { "schemas": { "AuthInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AuthInvalid" ] }, "statusCode": { "type": "number", "enum": [ 401 ] }, "code": { "type": "string", "enum": [ "auth_invalid" ] }, "message": { "type": "string", "enum": [ "Bearer credential rejected" ] } }, "required": [ "_tag", "statusCode", "code", "message" ], "additionalProperties": false }, "AuthMissingEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AuthMissing" ] }, "statusCode": { "type": "number", "enum": [ 401 ] }, "code": { "type": "string", "enum": [ "auth_missing" ] }, "message": { "type": "string", "enum": [ "Bearer credential required" ] } }, "required": [ "_tag", "statusCode", "code", "message" ], "additionalProperties": false }, "RequestInvalidBodyEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RequestInvalidBody" ] }, "statusCode": { "type": "number", "enum": [ 400 ] }, "code": { "type": "string", "enum": [ "invalid_body" ] }, "message": { "type": "string" } }, "required": [ "_tag", "statusCode", "code", "message" ], "additionalProperties": false }, "WorkspaceNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "WorkspaceNotFound" ] }, "statusCode": { "type": "number", "enum": [ 404 ] }, "code": { "type": "string", "enum": [ "workspace_not_found" ] }, "message": { "type": "string", "enum": [ "No such workspace for this account: save a company profile or pick a workspace you belong to" ] } }, "required": [ "_tag", "statusCode", "code", "message" ], "additionalProperties": false }, "CampaignNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "CampaignNotFound" ] }, "statusCode": { "type": "number", "enum": [ 404 ] }, "code": { "type": "string", "enum": [ "campaign_not_found" ] }, "message": { "type": "string", "enum": [ "No campaign with this id belongs to the workspace" ] } }, "required": [ "_tag", "statusCode", "code", "message" ], "additionalProperties": false } }, "securitySchemes": { "bearer": { "description": "Send `Authorization: Bearer `. The token is an API key, which starts with `bav_` and comes from creating an API key or starting a registration, or the access token of a Bavlio sign-in.", "type": "http", "scheme": "Bearer" } } }, "security": [], "tags": [ { "name": "Registration", "description": "Open a Bavlio account without signing in. Starting a registration returns an API key for a new ephemeral account, which becomes permanent once its email address is verified." }, { "name": "Authentication", "description": "Identify the calling account, finish a registration and manage the account's API keys." }, { "name": "Account", "description": "The account behind your sign-in, and deleting it." }, { "name": "Workspaces", "description": "A workspace holds the company profile, outreach schedule, team, campaigns and billing Bavlio works with. Calls that act in a workspace use the one whose id is in the bavlio-workspace header, or the account's default workspace when the header is absent." }, { "name": "Teams", "description": "Manage who belongs to a workspace: its members, their roles and the invitations to join it. Each workspace's plan sets how many team seats it has." }, { "name": "Campaigns", "description": "A campaign finds leads that match an ideal customer profile (ICP) and buying signals, and reaches out to them through its sequence of LinkedIn and email steps." }, { "name": "Lead imports", "description": "Bring your own leads: preview a CSV, confirm which column holds what, then import it into a campaign, where the leads go through the same sequence as the ones Bavlio finds." }, { "name": "Sequences", "description": "A campaign's sequence is the steps Bavlio runs for each lead: profile visits, likes, invites, LinkedIn messages, emails, waits and conditions. Every message and email waits in the review queue for approval before it is sent." }, { "name": "Inbox", "description": "Conversations with the people your campaigns reached and, for accounts that opt in, your other LinkedIn and email conversations: read them, reply to them and follow changes live." }, { "name": "Reviews", "description": "Messages and emails go to a lead only after someone approves them. The review queue holds the replies Bavlio drafted for people who answered and the messages and emails it drafted for campaign sequences." }, { "name": "Billing", "description": "The plans on offer and the workspace's subscription and usage. Plan changes, cancellation and the billing portal need the workspace owner or an admin." }, { "name": "LinkedIn", "description": "Connect the LinkedIn accounts your campaigns send from, confirm their sign-ins, choose the country LinkedIn sees them from, and disconnect them." }, { "name": "Meetings", "description": "Meetings booked through the workspace's calendar tool (Google Calendar, Calendly or Cal.com), and the calendar connection that imports them." }, { "name": "Email", "description": "Connect a Bavimail account, add sending domains and tracking domains, and create the inboxes campaigns send email from." } ], "servers": [ { "url": "https://api.bavlio.com" } ] } ```