Get detailed campaign traffic report

GET 
/v1/stats/:reportId

Gets a report.

Send a GET request to the report URL returned by GET /v1/stats.

Example:

https://apis.indeed.com/ads/v1/stats/68dd7bee34c4846dfea43875405836?v=6

.

If the response is 202, try again later.

If the response is 200, the response body contains the report in CSV format.

Example version 6 report

Campaign ID,Advertisement,Job,Job Reference Number,Platform,Clicks,
  Impressions,Conversions,Indeed Apply Conversions,Spend (currency),
  Organic Clicks,Organic Impressions,Apply Starts,Organic Apply Starts

ecc0e827cc1650c1,"Hand Model",D6US908,mobile,4.0,233,1.0,1,3.43(USD),3,5,2,4 

OAuth scope	Access token type
Employer account details: employer.advertising.campaign_report.read	Employer access token.

Request

Path Parameters

reportId stringrequired

ID of the report that the v1/stats/ resource returns in a Location header.

Query Parameters

v string

Possible values: [1, 5, 6, 7, 8]

Default value: 1

Report version.

• 1: Legacy version 1.

• 5: Includes Campaign ID and Organic Metric columns.

• 6: Preferred version. Includes Campaign ID, Organic Metric, and ApplyStarts columns.

• 7: Preferred version. Includes Campaign ID, Organic Metric, ApplyStarts, and Organic Conversions columns.

• 8: Preferred version. Includes Campaign ID, Organic Metric, ApplyStarts, Organic Conversions, Employer Job ID (IRI), and Employer Job ID (UUID) columns.

Responses

202

Accepted

Response Headers

• Location

  string

  Path to the report

401

Request did not include a valid access token:

• The @@PH0@@ 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[]

Errors that prevented the request from being processed successfully.

If there are no errors, this 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": "<p>Invalid OAuth access token.</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

403

Valid access token that cannot be used with this API.

Inspect the error returned in meta.errors for details.

Error type	Meaning and common causes
INSUFFICIENT_SCOPE	The access token does not have the OAuth v2 token scope required for this API endpoint. For common causes, see FAQ and troubleshooting.
NOT_EMPLOYER_ACCESS_TOKEN	This endpoint requires an Employer access token. That is, you must specify the employer parameter when requesting the access token. You need to do this for the majority of the Sponsored Jobs API endpoints.
LEGACY_ACCESS_TOKEN_NOT_ALLOWED	Sponsored Jobs API no longer supports access tokens that you get through legacy OAuth endpoints. For updated endpoints, see Integrate with Indeed and call APIs.

application/json

Schema

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this 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": 403,
    "errors": [
      {
        "type": "INSUFFICIENT_SCOPE",
        "description": "<p>Access token does not have permission to access this API.</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

500

Unexpected error occurred.

The problem is sometimes temporary and the exact same request may succeed after retrying.

If retrying the request does not help, a problem with parsing the request might have occurred.

Verify that all the required parameters are present and that all parameters are correctly formatted.

If you use an access token obtained with client credentials grant type (2-legged OAuth) with the legacy Sponsored Jobs API endpoint, the INTERNAL_SERVER_ERROR error occurs.

Be sure to use the latest base URL (

https://apis.indeed.com/ads

).

application/json

Schema

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this 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": "<p>Failed to process the request.</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

Loading...

 

Was this page helpful?