API docs by Redocly

Joveo APIs

The Joveo APIs integrate your jobs with our intelligent programmatic job advertisement platform, which are consistent, discoverable, simple to use, and provide necessary abstraction.

The APIs are organized around REST and are exposed to the agency to manage resources like client, job, campaign, job group, feed, posting, and stats. Our APIs have predictable resource-oriented URLs, accept JSON-encoded request bodies, return JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. Each API has a description and example of path, query parameters, headers, request body, and response.

Authentication/Authorization: We use Amazon Cognito for Authentication and Authorization using OAuth 2.0 which is industry-standard protocol for authorization. It involves checking resources that the user is authorized to access or modify via defined scopes/claims using JWT Tokens.

The following keys will be needed in request header to access all the listed APIs- 

x-api-key: API key for accessing the API. 
x-authorization-key: Authorization token to authorize whether its a valid request or not.

Your API key and Authorization key carry many privileges, so be sure to keep them secure! Do not share your keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Errors: The simplest way we handle errors is to respond with an appropriate status code. Description of the same can be found in respective API sections below.

In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, failed authorization, etc.). Codes in the 5xx range indicate an error with servers (these are rare). Error codes in our case are:

  • 400 Bad Request – client sent an invalid request, such as lacking required request body or parameter.

  • 401 Unauthorized – Missing or invalid x-api-key.

  • 403 Forbidden – client authenticated but does not have permission to access the requested resource: Missing or invalid x-authorization key/client_id

  • 404 Not Found – the requested resource does not exist

  • 500 Internal Server Error – a generic error occurred on the server

Pagination: Pagination works to separate content into pages for easy content consumption. It is a standard method, where the data is retrieved in batches by making multiple calls to the server. All top-level API resources have support for bulk fetches.

We use page-based pagination where endpoints accept limit and page as query params. The database skips the first N (limit * page) results of the query in order and returns the records next to them. 

limit: Number of records per page 
page: Indicates the page number within the list to be returned

Environment: We have exposed our APIs on two environments:

  • prod

  • staging

Staging environment exactly resembles the prod environment. Unlike development or limited integration test environment, staging environment utilizes the same back-end and up-and-downstream services. It has same architecture, the same scale and identical configurations to the production environment.

Clients/ End-users can also use staging environment for testing purposes if required.

Access Token Generator API

Access token generator API to generate x-authorization-key for a api client. Access token will be valid for 1 day, client need to generate access token each day for accessing apis.

Generate access token.

This api generates an access token for a api client, client can pass the token in header of api request as x-authorization-key.

header Parameters
x-api-key
required
string

API key for accessing the API.

Request Body schema: application/json
client_id
string

The client id of external api client, this is not same as mojo client id.

Responses

Request samples

Content type
application/json
{
  • "client_id": "l81n0sqr0la15s23g78h8aqaf"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJraWQiOiJmT0QxNW1ZXWF.......lWxSXQs6YkdTv81ak6i3tCtWmW0Nfw",
  • "expires_in": 86400,
  • "token_type": "Bearer"
}

Client APIs

Client APIs are used to manage clients of the agency. Client APIs allow CREATE, READ, UPDATE, DELETE and pause/enable for a given client.

Create a client.

This api creates a client with onboarding details for a specific agency.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
companyName
string

Name of the client. Used for display purpose.

exportedName
string

The name used for creating FTP files for publishers.

applyConvWindow
integer

This is used to track if an apply event is within the conversion window or not. Applies happening after the conversion window are not considered valid.

timeZone
string

Time zone of client.The format is UTC±Hh:mm

endDate
string

The end date of the client. Default date format is mm/dd/yyyy.

startDate
string

The start date of the client. Default date format is mm/dd/yyyy.

object (Create Client Caps)
clientType
string

Inidcates type of client.

advertiserName
string

Advertiser name for client. This field is used to populate the advertiser node, of a job, in outbound.

Responses

Request samples

Content type
application/json
{
  • "companyName": "New External API-789",
  • "exportedName": "external-1",
  • "applyConvWindow": 35,
  • "timeZone": "UTC-10:00",
  • "endDate": "20/04/2020",
  • "startDate": "20/03/2020",
  • "caps": {
    },
  • "clientType": "DirectEmployer",
  • "advertiserName": "abc"
}

Response samples

Content type
application/json
{
  • "result": "7baeb0b8-ae6f-4jed-b80f-az8z86a917d4",
  • "message": "client created"
}

Get all clients.

This api fetches details of all clients for a specific agency.

query Parameters
page
required
integer

Page number for pagination.

limit
required
integer

Number of client details per page.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether it's a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a client.

This api updates a specific client details.

path Parameters
client_id
required
string

Client id to update specific client.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
Any of
object (Create Client Budget)
object (Create Client Applies)

Responses

Request samples

Content type
application/json
Example
{
  • "budget": {
    },
  • "applies": {
    }
}

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Client Updated"
}

Get a client.

This api fetches details of a specific client.

path Parameters
client_id
required
string

Client id to get details of specific client.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "id": "0b24ce32-5462-9024-a397-de37da501zzz",
  • "children": { },
  • "companyName": "jobgroup-saving",
  • "exportedName": "Jobgroup saving",
  • "startDate": "13/05/2020",
  • "endDate": "25/05/2020",
  • "timeZone": "UTC-11:00",
  • "ats": "ADP Apply 2 Jobs",
  • "caps": {
    },
  • "startDefaultCampaign": false,
  • "clientType": "DirectEmployer",
  • "markdown": 2,
  • "applyConvWindow": 30,
  • "excludedPublishers": [
    ],
  • "globallyExcludedPublishers": [
    ]
}

Delete a client.

This api deletes a specific client.

path Parameters
client_id
required
string

Client id to delete specific client.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Client Deleted"
}

Get status of a client.

This api fetches the status of a specific client.

path Parameters
client_id
required
string

Client id to get status of specific client.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": "A",
  • "message": "Status fetched successfully"
}

Fetches custom idx fields mappings of a specific client.

This api fetches custom idx fields mappings of a specific client.

path Parameters
client_id
required
string

Client id to fetch custom idx fields mappings of a specific client.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "external-data": "cif1",
  • "day": "cif2",
  • "cpc": "cif3"
}

Pause a client.

This api pauses a specific client.

path Parameters
client_id
required
string

Client id to pause specific client.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Client paused"
}

Enable a client.

This api enables a specific client.

path Parameters
client_id
required
string

Client id to enable specific client.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Client enabled"
}

Job APIs

Job APIs are used to manage the jobs of clients. Job APIs allow CREATE, READ, UPDATE, DELETE and pause/enable for a given job.

Add a job.

This api creates a job for the given client.

path Parameters
client_id
required
string

Client id of a job.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
refNumber
string

Unique reference number of job.

title
string

Title of job.

company
string

Company name of job.

description
string

Description of job.

category
string

Category of job.

url
string

Current url of job.

alternateURL
string

Alternate url of job.

city
string

City of job location.

state
string

State of job location.

country
string

Country of job location.

zip
string

Zip code of job location.

publishedDate
string

Published date of job.

endAtDate
string

Job will get deleted after this date.

jobType
string

Type of job.

object (Additional Fields)
object (Publishers Fields)
object (Job Setting)
Array of objects (Job Placement Setting)

Responses

Request samples

Content type
application/json
{
  • "refNumber": "test-job-ref-number-19",
  • "title": "test title",
  • "company": "test company",
  • "description": "apply for this single job",
  • "category": "Maintenance",
  • "url": "http://9nl.es/U2ZJY3",
  • "alternateURL": "https://www.nxtpreprod.monster.com/job-openings/software-developer-new-york-city-ny--48e3732b -768b-473d-8fce-11bc1f6b1316",
  • "city": "Eluru",
  • "state": "Telangana",
  • "country": "US",
  • "zip": 500081,
  • "publishedDate": "2019-11-29T10:00:00.000Z",
  • "endAtDate": "2019-11-29T10:00:00.000Z",
  • "jobType": "FULL_TIME",
  • "additionalFields": {
    },
  • "publisherFields": {
    },
  • "jobSetting": {
    },
  • "placementSettings": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "e13cd1d459a7be781712aa2636a9580c",
  • "message": "Job created"
}

Get all jobs.

This api fetches up to 10K jobs for the given client in paginated manner.

path Parameters
client_id
required
string

Client id to get all Jobs of client.

query Parameters
page
required
integer

page number starts from 1

limit
required
integer

limit ranges from [1, 1000]

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "summary": 100
}

Get a job.

This api fetches job details for given client and reference number.

path Parameters
client_id
required
string

Client id of a job

job_reference
required
string

Reference number of a job.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "refNumber": "test-job-ref-number-19",
  • "title": "test title",
  • "company": "test company",
  • "description": "apply for this single job",
  • "category": "Maintenance",
  • "originalUrl": "https://www.joveo.addeed.com/",
  • "alternateURL": "https://www.joveo.addeed.com/",
  • "city": "Eluru",
  • "state": "Telangana",
  • "country": "US",
  • "jobId": "e13cd1d459a7be781712aa2636a9580c",
  • "zip": 500081,
  • "createdAtDate": "2019-11-29T10:00:00.000Z",
  • "updatedAtDate": "2019-11-29T10:00:00.000Z",
  • "pubDate": "2019-11-29T10:00:00.000Z",
  • "postedDate": "2019-11-29T10:00:00.000Z",
  • "modifiedDate": "2019-11-29T10:00:00.000Z",
  • "type": "FULL_TIME",
  • "additionalFields": {
    },
  • "publisherFields": {
    },
  • "jobSetting": {
    },
  • "placementSettings": [
    ],
  • "clientId": "40194b3f-7b49-41e8-b235-4d93a50330f3",
  • "valid": true,
  • "status": "ACTIVE"
}

Delete a job.

This api deletes the job based on client and reference number.

path Parameters
client_id
required
string

Client id of a job.

job_reference
required
string

Reference number of a job.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Job deleted"
}

Update a job.

This api updates job details based on reference number provided job is valid.

path Parameters
client_id
required
string

Client id of a job.

job_reference
required
string

Reference number of a job.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
title
string

Title of job.

company
string

Company name of job.

description
string

Description of job.

category
string

Category of job.

url
string

Current url of job.

alternateURL
string

Alternate url of job.

city
string

City of job location.

state
string

State of job location.

country
string

Country of job location.

zip
string

Zip code of job location.

publishedDate
string

Published date of job.

endAtDate
string

Job will get deleted after this date.

jobType
string

Type of job.

object (Additional Fields)
object (Publishers Fields)
object (Job Setting)
Array of objects (Job Placement Setting)

Responses

Request samples

Content type
application/json
{
  • "title": "test title",
  • "company": "test company",
  • "description": "apply for this single job",
  • "category": "Maintenance",
  • "url": "http://9nl.es/U2ZJY3",
  • "alternateURL": "https://www.nxtpreprod.monster.com/job-openings/software-developer-new-york-city-ny--48e3732b -768b-473d-8fce-11bc1f6b1316",
  • "city": "Eluru",
  • "state": "Telangana",
  • "country": "US",
  • "zip": 500081,
  • "publishedDate": "2019-11-29T10:00:00.000Z",
  • "endAtDate": "2019-11-29T10:00:00.000Z",
  • "jobType": "FULL_TIME",
  • "additionalFields": {
    },
  • "publisherFields": {
    },
  • "jobSetting": {
    },
  • "placementSettings": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "e13cd1d459a7be781712aa2636a9580c",
  • "message": "Job updated"
}

Pause a job.

This api pauses the job based on client and reference number provided job is valid.

path Parameters
client_id
required
string

Client id of a job.

job_reference
required
string

Reference number of a job.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Job paused"
}

Enable a job.

This api enables the job based on client and reference number provided job is valid.

path Parameters
client_id
required
string

Client id of a job.

job_reference
required
string

Reference number of a job.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Job enabled"
}

Get jobs in bulk.

This api fetches job details for given list of jobids for the client.

query Parameters
client_id
required
string

Client id of a job.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "e13cd1d459a7be781712aa2636a9580c",
  • "e13cd1d459a7be781712aa2636a9580d"
]

Response samples

Content type
application/json
[
  • {
    }
]

Campaign APIs

Campaign APIs are used to manage the campaigns of clients. Campaign APIs allow CREATE, READ, UPDATE, DELETE and pause/enable for a given campaign.

Create a campaign.

This api creates a campaign for a specific client.

path Parameters
client_id
required
string

Client id to create campaign.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
name
string

Name of campaign.

startDate
string

Start date of campaign. Format should be mm/dd/yyyy.

endDate
string

End date of campaign. Format should be mm/dd/yyyy.

object (Create Campaign Caps)

Responses

Request samples

Content type
application/json
{
  • "name": "test-campaign-api-1",
  • "startDate": "01/10/2020",
  • "endDate": "07/30/2020",
  • "Caps": {
    }
}

Response samples

Content type
application/json
{
  • "result": "f2fb5642-668b-4579-82c4-0f0cb889c21e",
  • "message": "campaign created"
}

Get all campaigns.

This api fetches all campaign details of a specific client.

path Parameters
client_id
required
string

Client id to fetch all campaigns of client.

query Parameters
page
required
integer

Page number for pagination.

limit
required
integer

Number of client details per page.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a campaign.

This api fetches a campaign details of a specific client.

path Parameters
client_id
required
string

Client id to fetch campaign of client.

campaign_id
required
string

Campaign id to fetch campaign details.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "id": "8f3142dc-d7b1-4b21-86e5-b151ae862664",
  • "name": "test-campaign-api-1",
  • "activeStatus": "A",
  • "settingsOverride": {
    },
  • "createdOn": "string",
  • "children": {
    },
  • "isDefault": false,
  • "caps": { },
  • "placementCaps": "string"
}

Delete a campaign.

This api deletes a campaign of a specific client.

path Parameters
client_id
required
string

Client id to delete campaign of client.

campaign_id
required
string

Campaign id to delete campaign.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Campaign deleted"
}

Update a campaign.

This api updates a campaign details of a specific client.

path Parameters
client_id
required
string

Client id to update campaign of client.

campaign_id
required
string

Campaign id to update campaign.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
object (Update Campaign Caps)

Responses

Request samples

Content type
application/json
{
  • "caps": {
    }
}

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Campaign updated"
}

Pause a campaign.

This api pauses a campaign of a specific client.

path Parameters
client_id
required
string

Client id to pause campaign of client.

campaign_id
required
string

Campaign id to pause campaign.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Campaign paused"
}

Enable a campaign.

This api enables a campaign of a specific client.

path Parameters
client_id
required
string

Client id to enable campaign of client.

campaign_id
required
string

Campaign id to enable campaign.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Campaign enabled"
}

Job group APIs

Job group APIs are used to manage job groups of clients. Job group APIs allow CREATE, READ, UPDATE, DELETE and pause/enable for a given job group.

Create a job group.

This api creates a job group of a specific campaign and client.

path Parameters
client_id
required
string

Client id to create new job group.

campaign_id
required
string

Campaign id to create new job group.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
name
string

Name of job group.

startDate
string

Start date of job group. Format should be mm/dd/yyyy.

endDate
string

Start date of job group. Format should be mm/dd/yyyy.

cpcBid
integer <double>

CPC bid of job group.

cpaBid
integer <double>

CPA bid of job group.

object (Create JobGroup Filters)
object (Create JobGroup Caps)
Array of objects (Create JobGroup Placements)

Responses

Request samples

Content type
application/json
{
  • "name": "test-jobgroup-200",
  • "startDate": "01/27/2020",
  • "endDate": "11/11/2038",
  • "cpcBid": 0.12,
  • "cpaBid": 1.5,
  • "filters": {
    },
  • "caps": {
    },
  • "placements": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "bebdddfc-fcc3-49b2-9390-7a9f2ef52f4d",
  • "message": "Jobgroup created"
}

Get all job groups.

This api fetches all job group details of a specific campaign and client.

path Parameters
client_id
required
string

Client id to fetch all job groups of a client for a specific campaign.

campaign_id
required
string

Campaign id to fetch all job groups of a client for a specific campaign.

query Parameters
page
required
integer

Page number for pagination.

limit
required
integer

Number of job group details per page.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether it's a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get all job groups.

This api fetches all job group of a client.

path Parameters
client_id
required
string

Client id to fetch all job groups of a client.

query Parameters
page
required
integer

Page number for pagination.

limit
required
integer

Number of job group details per page.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a job group.

This api fecthes a specific job group details of a specific campaign and client.

path Parameters
client_id
required
string

Client id to fetch specific job group.

campaign_id
required
string

Campaign id to fetch specific job group.

jobgroup_id
required
string

Job group id to fetch specific job group.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "id": "df8285cd-2ab4-44ab-8861-9ff3be0c4970",
  • "Compound Filters": {
    },
  • "name": "string",
  • "placementIds": [
    ],
  • "activeStatus": "A",
  • "settingsOverride": {
    },
  • "adWordsMetadata": {
    },
  • "createdOn": "2019-11-11T08:33:47.000Z",
  • "isDefault": false,
  • "caps": {
    },
  • "placementCaps": { },
  • "priority": 0,
  • "performanceTargets": [
    ],
  • "ioDetails": [
    ],
  • "categories": [
    ],
  • "iid": 1
}

Delete a job group.

This api deletes a specific job group of a specific campaign and client.

path Parameters
client_id
required
string

Client id to delete job group.

campaign_id
required
string

Campaign id to delete job group.

jobgroup_id
required
string

Job group id to delete job group.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Jobgroup deleted"
}

Update a job group.

This api updates a specific job group details of a specific campaign and client.

path Parameters
client_id
required
string

Client id to update job group.

campaign_id
required
string

Campaign id to update job group.

jobgroup_id
required
string

Job group id to update job group.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
name
string

Name of job group.

cpaBid
integer <double>

CPC bid of job group.

object (Create JobGroup Filters)

Responses

Request samples

Content type
application/json
{
  • "name": "test jobgroup updated1",
  • "cpaBid": 0.22,
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Jobgroup updated"
}

Pause a job group.

This api pauses a specific job group of a specific campaign and client.

path Parameters
client_id
required
string

Client id to pause job group.

campaign_id
required
string

Campaign id to pause job group.

jobgroup_id
required
string

Job group id to pause job group.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Jobgroup paused"
}

Enable a job group.

This api enables a specific job group of a specific campaign and client.

path Parameters
client_id
required
string

Client id to enable job group.

campaign_id
required
string

Campaign id to enable job group.

jobgroup_id
required
string

Job group id to enable job group.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Jobgroup enabled"
}

Feed APIs

Feed APIs are used to manage the feeds of clients. Feed APIs allow CREATE, READ, UPDATE, DELETE and pause/enable for a given feed.

Create a feed.

This api creates a feed for a specific client.

path Parameters
client_id
required
string

Client id to add feed of client.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
xmlFeedUrl
string

XML url of feed.

object (Create Feed Schema Mappings)

Responses

Request samples

Content type
application/json
{
  • "xmlFeedUrl": "string",
  • "schemaMappings": {
    }
}

Response samples

Content type
application/json
{
  • "result": "36e90f46-9d9e-42ac-accb-559de107bbc8",
  • "message": "Feed created"
}

Get all feeds.

This api fetches all feed details of a specific client.

path Parameters
client_id
required
string

Client id to get all feed details of client.

query Parameters
page
required
integer

Page number for pagination.

limit
required
integer

Number of client details per page.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a feed.

This api fetches a specific feed details of a specific client.

path Parameters
client_id
required
string

Client id to get details of specific feed.

feed_id
required
string

Feed id of feed.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "clientId": "3788ba55-a0c5-43ec-9982-65bb1344fa2b",
  • "source": "",
  • "config": {},
  • "createdOn": "2021-04-29T10:57:43.000Z",
  • "lastUpdated": "2021-04-29T10:57:43.000Z",
  • "active": true,
  • "schemaMappings": {
    },
  • "urlParamsToStrip": [
    ],
  • "id": "277bc914-a6eb-44a4-beea-cb1c2bd60d24",
  • "deleted": false,
  • "schemaValueOverrides": { },
  • "schemaValueDefaults": { },
  • "mandatoryFields": [
    ]
}

Delete a feed.

This api deletes a specific feed details of a specific client.

path Parameters
client_id
required
string

Client id to delete specific feed.

feed_id
required
string

Feed id of feed.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Feed deleted"
}

Update a feed.

This api updates a feed details of a specific client.

path Parameters
client_id
required
string

Client id to update specific feed.

feed_id
required
string

Feed id of feed.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
xmlFeedUrl
string

XML feed url of feed.

object (Update Feed Schema Mapping)
schemaMappingPublisher
object

Node name in feed which has publishes list.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "result": "277bc914-a6eb-44a4-beea-cb1c2bd60d24",
  • "message": "Feed updated"
}

Posting Jobs APIs

Posting Jobs APIs are used to manage jobs of posting. Posting Jobs APIs allow fetch jobs posted over publisher/added to config and pin/unpin jobs of config.

Get jobs posted over publisher.

This api fetches all jobs posted over specific publisher of a specific client.

path Parameters
client_id
required
string

Client id to fetch all jobs posted over publisher.

publisher_id
required
string

Publisher id to fetch all jobs posted over publisher.

query Parameters
page
required
integer

Page number for pagination.

limit
required
integer

Number of posting details per page.

pinned
boolean
Enum: true false

Indicates whether jobs needs to fetched are pinned jobs or unpinned jobs of config.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get all jobs of specific posting.

This api fetches all jobs posted over a specific config/posting of a specific client.

path Parameters
client_id
required
string

Client id to fetch all jobs of config.

config_id
required
string

Config id to fetch all jobs of config.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "test-job-ref-number-108",
  • "test-job-ref-number-109"
]

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "Create request processed"
}

Posting Config APIs

Posting config APIs are used to manage postings. Posting Config APIs allow CREATE, READ, UPDATE, DELETE and view jobs of given config/posting.

Create a config/posting.

This api creates a config for specific client over specific publisher.

path Parameters
client_id
required
string

Client id to create a config.

publisher_id
required
string

Publisher id to create a config.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
cost
number

Cost of posting.

startDate
string

Start date of posting.

endDate
string

End date of posting.

dateFormat
string

Date format for posting.

availableCount
integer

Total available posting count.

rotateFreqInDays
integer

Posting rotate frequency in days.

jobDuration
integer

Duration of job in posting.

minJobDurationInDays
integer

Minimum job duration in posting.

Responses

Request samples

Content type
application/json
{
  • "cost": 220,
  • "startDate": "2020-08-03T05:19:00.000Z",
  • "endDate": "2020-08-03T05:13:00.000Z",
  • "dateFormat": "yyyy-MM-dd'T'HH:mm:ssZ",
  • "availableCount": 100,
  • "rotateFreqInDays": 2,
  • "jobDuration": 10,
  • "minJobDurationInDays": 2
}

Response samples

Content type
application/json
{
  • "result": "213d2dcb-d72b-43fb-85bc-71e1aaa8fe8a",
  • "message": "Config created"
}

Get all config/posting.

This api fetches all config details of specific client over specific publisher.

path Parameters
client_id
required
string

Client id to fetch all configs of client and publisher.

publisher_id
required
string

Publisher id to fetch all configs of client and publisher.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "id": "213d2dcb-d72b-43fb-85bc-71e1aaa8fe8a",
  • "agencyId": "ripple",
  • "clientIds": [
    ],
  • "placement": "TestExp1",
  • "placementName": "TestExp1",
  • "cost": 220,
  • "costPerJobPerDay": 20,
  • "costPerSlotPerHour": 2,
  • "startDate": "2020-08-03T05:19:00.000Z",
  • "endDate": "2020-08-03T05:13:00.000Z",
  • "duration": 124,
  • "availableCount": 100,
  • "rotateFreqInDays": 2,
  • "usedCount": 0,
  • "lastRotated": "2020-08-03T05:13:00.000Z",
  • "isActive": false,
  • "lastUpdated": "2020-08-03T05:13:00.000Z",
  • "createdOn": "2020-08-03T05:13:00.000Z",
  • "jobDuration": 10,
  • "postedJobsCount": 0,
  • "configType": "string",
  • "minJobDurationInDays": 2,
  • "billingType": {
    },
  • "purchaseType": {
    }
}

Update a config/posting.

This api updates a specific config of specific client over specific publisher.

path Parameters
client_id
required
string

Client id to update specific config.

publisher_id
required
string

Publisher id to update specific config.

config_id
required
string

Config id to update specific config.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
cost
number

Cost of posting.

endDate
string

End date of posting.

availableCount
integer

Total available posting count.

rotateFreqInDays
integer

Posting rotate frequency in days.

jobDuration
integer

Duration of job in posting.

minJobDurationInDays
integer

Minimum job duration in posting.

Responses

Request samples

Content type
application/json
{
  • "cost": 1000,
  • "endDate": "2020-08-03T05:13:00.000Z",
  • "availableCount": 50,
  • "rotateFreqInDays": 5,
  • "jobDuration": 20,
  • "minJobDurationInDays": 2
}

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Config update processed"
}

Get a config/posting.

This api fetches a specific config details of specific client over specific publisher.

path Parameters
client_id
required
string

Client id to fetch specific config.

publisher_id
required
string

Publisher id to fetch specific config.

config_id
required
string

Config id to fetch specific config.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "id": "213d2dcb-d72b-43fb-85bc-71e1aaa8fe8a",
  • "agencyId": "ripple",
  • "clientIds": [
    ],
  • "placement": "TestExp1",
  • "placementName": "TestExp1",
  • "cost": 220,
  • "startDate": "2020-08-03T05:19:00.000Z",
  • "endDate": "2020-08-03T05:13:00.000Z",
  • "dateFormat": "yyyy-MM-dd'T'HH:mm:ssZ",
  • "availableCount": 100,
  • "rotateFreqInDays": 2,
  • "jobDuration": 10,
  • "minJobDurationInDays": 2,
  • "billingType": "PREPAID",
  • "purchaseType": "ClientBilled",
  • "isActive": false,
  • "usedCount": 0
}

Delete a config/posting.

This api deletes a specific config of specific client over specific publisher.

path Parameters
client_id
required
string

Client id to delete specific config.

publisher_id
required
string

Publisher id to delete specific config.

config_id
required
string

Config id to delete specific config.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "Config update processed"
}

Get jobs of a specific config/posting.

This api fetches all jobs of a specific config of specific client over specific publisher.

path Parameters
client_id
required
string

Client id to fetch jobs of config.

publisher_id
required
string

Publisher id to fetch jobs of config.

config_id
required
string

Config id to fetch jobs of config.

query Parameters
isPaused
boolean
Enum: true false

Indicates, whether jobs need to be fetched, are paused jobs or active jobs of config.

isPinned
boolean
Enum: true false

Indicates, whether jobs need to be fetched, are pinned jobs or unpinned jobs of config.

isPosted
boolean
Enum: true false

Indicates, whether jobs need to be fetched, are posted jobs or not.

status
string
Enum: "A" "P"

Indicates, whether jobs need to be fetched, are active jobs or paused jobs of config.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get the specific job posted over publisher of a specific config/posting.

This api fetches the job of a specific config of specific client over specific publisher.

path Parameters
client_id
required
string

Client id to fetch specific job posted over publisher of config.

publisher_id
required
string

Publisher id to fetch specific job posted over publisher of config.

config_id
required
string

Config id to fetch specific job posted over publisher of config.

job_reference
required
string

Job reference to fetch specific job posted over publisher of config.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "id": "f4f71332-5013-44f3-9e66-1e732149aa09",
  • "clientId": "3788ba55-a0c5-43ec-9982-65bb1344fa2b",
  • "jobId": "1b123575a6037f46f0c2327e2cfad81b",
  • "placement": "TestExp1",
  • "refNumber": "test-job-ref-number-19",
  • "isPosted": true,
  • "isPinned": true,
  • "isPaused": true,
  • "lastModified": "2021-05-03T08:58:42.000Z",
  • "createdOn": "2021-05-03T08:58:42.000Z",
  • "status": "A"
}

Get all configs/postings.

This api fetches all config details of a specific client.

path Parameters
client_id
required
string

Client id to fetch all configs of client.

query Parameters
page
required
integer

Page number for pagination.

limit
required
integer

Number of config details per page.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Stats APIs

Stats APIs is used to fetch the performance statistics of a client. The data is available for last 60 days.

Submit Request for generating Stats Report

This API submits a request to generate stats report for a specific client Asyncronously.

1. Statistics like CPC, CPA, CTA, ATH, CPH are aggregate measures, Please do not aggregate (sum/average) these measures further. For instance, if you get two records for a client from the API one has CPC of 0.10$ and the other has CPC of 0.20 $ and if you are preparing a client level report, You should not report CPC as either sum (0.30) or average (0.15) of the two individual rows. If you want to aggregate data after downloading it from the API, recalculate these fields.

2. The data for the current month can be updated as the month proceeds due to multiple business reasons. For instance, if you call the API on 5th May to get the data for 4th May you can get 100 clicks but if you call the API on 7th May for getting the data of 4th May, you can get 80 clicks. This is an acceptable and valid business scenario. Thus, it is recommended that you refresh the data for the entire month every day. [The statistics are frozen by the 8th day of the next month. For instance statistics of May will be frozen by 8th June, Thus you should refresh the statistics data for complete May till the 8th of June. To be on the safer side, you can refresh data for the last 40 days every day]

header Parameters
x-client-id
required
string

Client id to fetch the stats.

x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
object (Async Stat Filters)
object (Aggregation Level)

primaryLevel, secondaryLevel and tertiaryLevel values should be unique.

secondaryLevel and tertiaryLevel are not mandatory.

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "aggregationLevel": {
    }
}

Response samples

Content type
text/plain
NO_CONTENT

API to poll the status of the submitted report request.

Status endpoint is used to know the status of the API submitted for report generation. We will return 'NO_RECORDS_FOUND' in case of no stats data at that particular date range.

path Parameters
taskId
required
string >= 1

The task id associated with the query generated for the report generation request.

header Parameters
x-client-id
required
string

Client id to fetch the stats.

x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
Example
{
  • "status": "SUCCESS",
  • "location": [
    ]
}

Stream a status report.

This api generates the stats report. It returns the streams of data every second. The api maintains the connection with the client and keeps returning the streamed responses until the entire report is downloaded.

Work In Progress: This api is in progress, it will be deployed soon.

header Parameters
x-client-id
required
string

Client whose report details are required.

x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
groupBy
string
Enum: "JOB" "JOBGROUP" "CAMPAIGN" "CLIENT"

Aggregate on level.

groupByPublisher
boolean
Enum: true false

second pivot to aggregate on publisher level on top of groupBy

callBackUrl
string

This url will be called when the report generation fails/succeeds. It will send status(SUCCESS/FAILED) and url of the generated report(if report generation succeeds)

object (Report Details FilterBy)

Responses

Request samples

Content type
application/json
{
  • "groupBy": "CLIENT",
  • "groupByPublisher": true,
  • "callBackUrl": "https:domain.com/report/reportId",
  • "filterBy": {
    }
}

Response samples

Content type
application/json
{
  • "streamNumber": 5,
  • "stats": [
    ]
}

Meta APIs

Meta APIs allow is used to fetch the metadata of a client. Meta APIs fetches the campaign and job group details of the client.

Get the meta data.

This api fetches the meta data of a specific client.

header Parameters
x-client-id
required
string

Client id to fetch meta data of client.

x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "campaigns": [
    ]
}

Rule APIs

Rule APIs are used to make a decision based on filters and conditions.

Apply job rules.

This api makes decision based on conditions and filters. It may pause or enable jobs of a client.

Work In Progress: This api is in progress, it will be deployed soon.

header Parameters
x-client-id
required
string

Client id to fetch the job level stats.

x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
clientId
string

Client id to apply rule.

campaignId
string

Campaign id to apply rule.

jobGroupId
string

Job group id to apply rule.

filterLevel
string
Enum: "clients" "jobs" "campaign" "jobgroups"

Filter level to apply rule.

applyToChildren
boolean
Enum: true false
Array of objects (Job Level Conditions)
conditionOp
string
Enum: "OR" "AND"

Condition operator to apply rule.

actionType
string

Action/Request type to apply rule.

name
string

Name of rule.

startDate
string

Start date of rule. Format should be mm/dd/yyyy.

endDate
string

End date of rule. Format should be mm/dd/yyyy.

object (Job Level Rules Job Filter)
jobFilterLevel
string
Enum: "clients" "campaign" "jobgroups"
object (Job Level Rules Action Type)
Array of objects (Job Level Rules Filters)

Responses

Request samples

Content type
application/json
{
  • "clientId": "63051e4d-1595-428e-892e-748e5a7fa9c8",
  • "campaignId": "df8285cd-2ab4-44ab-8861-9ff3be0c4970",
  • "jobGroupId": "sd8285dd-2ab4-44ab-8861-9ff3blhgdgs1m",
  • "filterLevel": "jobs",
  • "applyToChildren": true,
  • "conditions": [
    ],
  • "conditionOp": "AND",
  • "actionType": "administration",
  • "name": "Pause Job",
  • "startDate": "05/10/2021",
  • "endDate": "05/31/2021",
  • "jobFilter": {
    },
  • "jobFilterLevel": "clients",
  • "adminActions": {
    },
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Report APIs

Report APIs are used to generate/view status of reports.

Generate the stats report.

This api triggers the generation of a stats report. It returns the report id which can be used to get the report's status. It also accepts an optional callback url which will be called when the report is generated.

Work In Progress: This api is in progress, it will be deployed soon.

header Parameters
x-client-id
required
string

Client whose report details are required.

x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
groupBy
string
Enum: "JOB" "JOBGROUP" "CAMPAIGN" "CLIENT"

Aggregate on level.

groupByPublisher
boolean
Enum: true false

second pivot to aggregate on publisher level on top of groupBy

callBackUrl
string

This url will be called when the report generation fails/succeeds. It will send status(SUCCESS/FAILED) and url of the generated report(if report generation succeeds)

object (Report Details FilterBy)

Responses

Request samples

Content type
application/json
{
  • "groupBy": "CLIENT",
  • "groupByPublisher": true,
  • "callBackUrl": "https:domain.com/report/reportId",
  • "filterBy": {
    }
}

Response samples

Content type
application/json
{}

Generate the IP report.

This api triggers the generation of a stats ip report. It returns the report id which can be used to get the report's status. It also accepts an optional callback url which will be called when the report is generated.

header Parameters
x-client-id
required
string

Client whose report details are required.

x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
callBackUrl
string

This url will be called when the report generation fails/succeeds. It will send status(SUCCESS/FAILED) and url of the generated report(if report generation succeeds)

object (Report Details FilterBy)

Responses

Request samples

Content type
application/json
{
  • "callBackUrl": "https:domain.com/report/reportId",
  • "filterBy": {
    }
}

Response samples

Content type
application/json
{}

Get a report.

This api gets the status and url of the generated report.

path Parameters
report_id
required
string

Report id to fetch the report details of.

header Parameters
x-client-id
required
string

Client whose report details are required.

x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples

Funnel Tracking APIs

Funnel Tracking APIs are used to submit candidate status on a particular job in bulk.

Updating candidate job application status.

This api updates the status of a candidates job application. It returns whether the updation has been successful or not.

header Parameters
x-client-id
required
string

Client whose candidate job status has to be updated. This is the id that joveo uses internally to reference the client.

x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not. This is access_token key that you receive in Access Token Generator API's response.

Request Body schema: application/json
One of
Array
jobApplicationId
string

This is the unique id that is generated when a candidate completes the job application process. This is the same id that would be tracked in joveo's pixels. Mandatory when being used for funnel creation logic.

candidateStatus
string

This is the new stage to which the candidate's application has moved in the hiring journey. These are mandatory fields in all the funnel creation logic.

timestamp
string

DateTime at which the candidate's application has been to moved to the current stage. This is mandatory fields in all the funnel creation logics. We support different set of formats of datetime.

object (Funnel Tracking Additional Details)

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

Content type
application/json
{
  • "success": true,
  • "failure": false,
  • "value": "1dffad4c-667c-45c7-90f6-58c1c0d86600"
}

S2S API

This API is to get application data from clients, which have s2s set up with Joveo.

/s2s/events

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

client_id
required
string

Client id.

Request Body schema: application/json
One of
clickId
string

Represents the value of the jClickId parameter appended to the URL. ClickId to which following conversion event belongs to.

a
string

It indicates the type of conversion performed on the Job. Value of 'a' will be 1,2,3 for VIEW, APPLY_START and APPLY conversions respectively.

candidateId
string

(Optional) candidate ID from the ATS.

jobApplicationId
string

(Optional) Job Application ID.This value is unique for each apply.

Responses

Request samples

Content type
application/json
Example
{
  • "clickId": "string",
  • "a": "string",
  • "candidateId": "string",
  • "jobApplicationId": "string"
}

Response samples

Content type
application/json
Example
{
  • "statusCode": 200,
  • "body": "Successfully sent s2s conversion event for further processing."
}

Publisher Report API

Publisher reports API is only for Joveo’s Publisher partners. This API is not applicable for Joveo’s customers.

Request Report Generation.

path Parameters
publisherFamilyId
required
string

publisherFamilyId.

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Request Body schema: application/json
reportName
string

Report Name as requested.

period
string
Enum: "LAST_MONTH" "THIS_MONTH" "LAST_30_DAYS"

Report Date Range.

clientId
string

ClientId (associated with the Publisher Family).

publisherFamilyId
string

Publisher Family Id for which the report is requested.

curLocale
string

Currency used by the Publisher Family or Client.

Responses

Request samples

Content type
application/json
{
  • "reportName": "string",
  • "period": "THIS_MONTH",
  • "clientId": "eba6971f-4880-4f05-bfbf-a308e30084e",
  • "publisherFamilyId": "6576baba5c2baf7cdd5b552a",
  • "curLocale": "USD"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "reportId": "eba6971f-4880-4f05-bfbf-a308e30084ea"
}

Get Report Generation Status.

path Parameters
publisherFamilyId
required
string

publisherFamilyId.

reportId
required
string

reportId

header Parameters
x-api-key
required
string

API key for accessing the API.

x-authorization-key
required
string

Authorization token to authorize whether its a valid request or not.

Responses

Response samples