Get organic job performance and prediction

POST 
/v1/organicjobprediction

Gets organic job performance and prediction.

This endpoint is for ATS partners only.

This endpoint provides:

• The organic traffic statistics of a single job for the past 30 days
• The estimated organic traffic statistics for the next 30 days
• The estimated improvement in traffic if the job is sponsored

The performance is expressed in terms of clicks.

All budget amounts are specified in USD.

To use this endpoint, the employer’s admin user must have an account set up at Indeed. See New employer account setup flow. However, if you do not have billing information set up for sponsoring, pass the type=login parameter in the URL to simplify the set-up flow.

OAuth scope	Access token type
employer_access	Access token that represents an employer.

Request

application/json

Body

required

job related information

jobInfo

object

jobsLocation stringrequired

• City where the job is located.
• Required if jobsQuery, and jobsSourceName are not provided, or for new jobs.

jobsQuery stringrequired

• Job query.
• Required if jobsSourceName is provided.

jobsSourceName stringrequired

• Source name for the job.
• Required if jobsQuery is provided.

jobsTitle stringrequired

• Job title.
• Required if jobsQuery, and jobsSourceName are not provided, or for new jobs.

Responses

200

Success

application/json

Schema

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

metric

object

clicks integer

Number of organic clicks the job got in past n number of days.

days integer

Number of days. Default is 30 days.

prediction

object

clicks integer

Estimated number of organic clicks the job gets in the next n number of days.

days integer

Number of days. Default is 30 days.

recommendation

object

clicks integer

Estimated number of sponsored clicks the job gets in the next n number of days with the recommended budget.

days integer

Number of days. Default is 30 days.

budget number

Recommended budget for sponsoring.

currencyCode string

Currency of the recommended budget.

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": {
    "metric": {
      "clicks": "30",
      "days": "40"
    },
    "prediction": {
      "clicks": "30",
      "days": "40"
    },
    "recommendation": {
      "clicks": "30",
      "days": "40",
      "budget": "250.0",
      "currencyCode": "USD"
    }
  }
}

Example

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": {
      "rel": "up",
      "href": "/v1/organicjobprediction"
    }
  },
  "data": {
    "metric": {
      "clicks": 30,
      "days": 40
    },
    "prediction": {
      "clicks": 30,
      "days": 40
    },
    "recommendation": {
      "clicks": 30,
      "days": 40,
      "budget": 250,
      "curreencyCode": "USD"
    }
  }
}

400

A request parameter is not valid. The description field usually contains the name of the problematic parameter and a more detailed error message.

Unlike other error types, the meta.errors array may contain multiple INVALID_REQUEST errors, one for each request parameter with a problem.

application/json

Schema

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

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 400,
    "errors": [
      {
        "type": "invalidRequest",
        "description": "jobsQuery: Job not found."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns"
      }
    ]
  },
  "data": null
}

401

Request did not include a valid access token:

• The Authorization header is missing or malformed. Include the access token using the Bearer scheme — for example, Authorization: Bearer XYZ.

• The access token is malformed. When building requests manually, check that you copied the token without missing or extra characters at the start or end.

• The access token has expired. Tokens expire after one hour (3,600 seconds). Get a new token using your client credentials (2-legged OAuth) or a refresh token (3-legged OAuth).

application/json

Schema

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

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 401,
    "errors": [
      {
        "type": "INVALID_TOKEN",
        "description": "Invalid OAuth access token."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

500

Unexpected error. The problem is sometimes temporary. The same request can succeed after retrying.

If retrying the request does not help, a problem with parsing the request might have occurred. Make sure that all the required parameters are present and that all parameters are correctly formatted.

application/json

Schema

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

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 500,
    "errors": [
      {
        "type": "INTERNAL_SERVER_ERROR",
        "description": "Failed to process the request."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

Loading...

 

Was this page helpful?