Skip to main content

Get general campaign information

GET 
/v1/campaigns/:campaignId

Gets the basic properties of a sponsored jobs campaign.

Request the employer.advertising.campaign.read OAuth scope to get an access token that represents an employer. See Get access token that represents employer.

OAuth scopeAccess token type
employer.advertising.campaign.read

Access token that represents an employer. See Get access token that represents employer.

Request​

Path Parameters

    campaignId stringrequired

    Campaign ID of the campaign to get.

Responses​

Returns general campaign information.

Schema

    meta

    object

    Response-related metadata.

    status int32

    HTTP status code of the response.

    errors

    object[]

    Any errors that prevented successful processing of the request. If there were no errors, the value is null.

  • Array [

    • type string

    Name of the error.

    description string

    Human-readable description of the problem.

  • ]

    • rootLocation string

    Base URL of the Sponsored Jobs API.

    perPage int32

    For endpoints that return paginated results, the effective maximum number of entries returned on one page. The value may be smaller than the maximum you requested with the perPage parameter. If the endpoint returns a single result or doesn't paginate, the value is null.

    links

    object[]

    Resources related to the requested resource.

  • Array [

    • rel string

    The relationship between the requested resource and the related resource. These values are commonly used:

    • up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.
    • next: The next page of entries in a paginated result.
    • prev: The previous page of entries in a paginated result.

    However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

    href string

    Endpoint URL of the related resource. Can contain query string parameters. To get the complete URL, append the href to rootLocation.

  • ]

    • data

    object

    Name string

    Possible values: non-empty and <= 250 characters

    Campaign name. Use to identify the campaign later. The name must be unique within your employer account.

    Id string

    Campaign ID. Automatically generated when the campaign is created.

    Type string

    Possible values: [SOURCE, HOSTED]

    Type of job sponsored by the campaign. Either SOURCE (jobs gathered from the web, or sent to Indeed using an XML feed) or HOSTED (jobs posted using the Post a Job page).

    Status string

    Possible values: [ACTIVE, DELETED, PAUSED]

    Default value: ACTIVE

    Campaign status. PAUSED creates a campaign that does not start sponsoring jobs until you manually enable it, or temporarily stops a campaign from sponsoring jobs.

    CurrencyCode string

    ISO 4217 currency code of the currency for the campaign's budget.

    TrackingToken string

    Possible values: <= 255 characters

    Click-tracking token appended to the job URL on sponsored clicks. Allows you to identify that the click is from Indeed, and identify the campaign that sponsored the click.

    Objective

    object

    Hiring goals that the campaign intends to achieve, and makes the campaign into an objective-based campaign. The value is a JSON object with an objectiveType field specifying the campaign objective, and for some objective types, a target field identifying the specific goal metric.

    For example, if the goal of the campaign is to supply 10 applications, set the objective to:

    {
      "objectiveType": "TARGET_APPLICATIONS",
      "target": 10
    }

    You can add an objective to a campaign that doesn't have one, and change the target value of an objective. However, you cannot remove an objective or change its objectiveType.

    objectiveType

    string

    Possible values: [BALANCE, MAXIMUM, QUICK, TARGET_APPLICATIONS, TARGET_COST_PER_APPLICATION, SCHEDULED_INTERVIEWS]

    The campaign objective. The available values are:

    • BALANCE: Get the most total applications for your budget, while balancing across jobs.
    • MAXIMUM: Get the most total applications for your budget, without balancing clicks across jobs.
    • QUICK: Five day campaign with higher budget for faster results. Sponsored Jobs API does not currently support creating or modifying campaigns with this objective. However, the Sponsored Jobs API does allow for retrieving campaign reports for campaigns with this objective type (these campaigns would have been created using Indeed for Employers).
    • TARGET_APPLICATIONS: Aim to reach the number of applications specified by target. When the target number of applications is hit, spend on these jobs is significantly reduced and allocated elsewhere.
    • TARGET_COST_PER_APPLICATION: Aim to keep the cost per application below the number specified by target.
    • SCHEDULED_INTERVIEWS: Send screened candidates straight to interview. Aim to reach the number of interviews specified by target. This objective requires an active Indeed Hiring Platform subscription, and should only be used when the customer is prepared to create hiring events for the included jobs.

    Campaigns created outside your application could use newly added objective types that aren't yet supported by your application. Your application should have fallback logic to handle unexpected objectiveType values.

    any

    NonSpendingReasons

    object[]

    Reasons that currently prevent the campaign from sponsoring jobs.

  • Array [

    • type string

    Possible values: [BEFORE_START_DATE, AFTER_END_DATE, ACCOUNT_MONTHLY_BUDGET_HIT, MONTHLY_BUDGET_HIT, ONETIME_BUDGET_HIT, JOB_SOURCE_NOT_VERIFIED, BILLING_PENDING, USER_PAUSED_CAMPAIGN, USER_DELETED_CAMPAIGN, TARGET_APPLICATIONS_HIT, OTHER]

    Identifier for the problem. The supported values are:

    • BEFORE_START_DATE: The current date in US Central Time is before the campaign start date.
    • AFTER_END_DATE: The current date in US Central Time is on or after the campaign end date.
    • ACCOUNT_MONTHLY_BUDGET_HIT: The employer account has already spent its budget this month.
    • MONTHLY_BUDGET_HIT: The campaign has already spent its budget this month.
    • ONETIME_BUDGET_HIT: The campaign has already spent its budget.
    • JOB_SOURCE_NOT_VERIFIED: The job source hasn't been verified by Indeed yet.
    • BILLING_PENDING: The employer account doesn't have valid billing information.
    • USER_PAUSED_CAMPAIGN: The campaign has been paused as requested.
    • USER_DELETED_CAMPAIGN: The campaign has been deleted as requested.
    • TARGET_APPLICATIONS_HIT: The campaign has already received the requested number of applications.
    • OTHER: Unknown reason.
    description string

    Human-readable description of the problem.

  • ]

    • SpendingChannels SpendingChannel[]

    Possible values: [TMN]

    Channels on which the campaign is spending. Excludes default channels.

    FundingSource string

    Funding source for the campaign:

    • Bonus Sponsored Job Credits: Funded with Annual Deals bonus credits.
    • Budget: Funded with regular budget.

    Possible values: [Bonus Sponsored Job Credits, Budget].

    SponsorshipPlan string

    Sponsorship plan for the Annual Deals bonus credits-funded campaign.

    • PREMIUM: Campaign uses the premium plan.
    • STANDARD: Campaign uses the standard plan.
    • "" (empty string): Normal campaign.

    Possible values: [PREMIUM, STANDARD, `` (empty string)]

Loading...

Was this page helpful?