Talroo Online Document API Reference

Talroo API Online Documents

API Endpoint
https://api.odt.io
Schemes: https
Version: 1.0.0

Authentication

Bearer

in
header
name
Authorization
type
apiKey

User Account

Authorize a user

GET user account login

GET /userAccount/login

Generate authorization token for a given user

login: string
in query

login

password: string
in query

password

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "title": "string",
  "message": "string"
}
Response Example (400 Bad Request)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "title": "string",
  "error": "string"
}

Get user account permissions

GET /userAccount/effectivePermissions

Provide customers' scopes and roles of their accounts:

Scopes: GROUP, CAMPAIGN & CUSTOMER
Roles: SUPER_ADMINISTRATOR, ADMINISTRATOR, NORMAL & READER

It will show every customer id, campaign id and groupd id this account can access.

User Permissions

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "title": "string",
  "data": {
    "CAMPAIGN": {
      "SUPER_ADMINISTRATOR": [
        "integer (int64)"
      ],
      "ADMINISTRATOR": [
        "integer (int64)"
      ],
      "NORMAL": [
        "integer (int64)"
      ],
      "READER": [
        "integer (int64)"
      ]
    },
    "CUSTOMER": {
      "SUPER_ADMINISTRATOR": [
        "integer (int64)"
      ],
      "ADMINISTRATOR": [
        "integer (int64)"
      ],
      "NORMAL": [
        "integer (int64)"
      ],
      "READER": [
        "integer (int64)"
      ]
    },
    "GROUP": {
      "SUPER_ADMINISTRATOR": [
        "integer (int64)"
      ],
      "ADMINISTRATOR": [
        "integer (int64)"
      ],
      "NORMAL": [
        "integer (int64)"
      ],
      "READER": [
        "integer (int64)"
      ]
    }
  }
}

Application

Only applicable if Talroo is hosting the online job application process. Read and download applicants' information

GET application download

GET /application/download

Download an applicant's resume. If resume is optional during the online job application process, an applicant may or may not have a resume

applicationId: integer (int64)
in query

applicationId

login: string
in query

login

password: string
in query

password

200 OK

Application Download Response

type
file
Response Content-Types: application/octet-stream
Response Example (200 OK)
"The resume as uploaded by the job seeker."

GET application report

GET /application/report

Retrieve a list of job applicant's

start: integer (int64)
in query

unix timestamp in milliseconds

end: integer (int64)
in query

unix timestamp in milliseconds

campaignIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?campaignIds=aaa,bbb
referenceNumbers: string[]
in query

referenceNumbers

Array values passed separated by comma: ?referenceNumbers=aaa,bbb

Application Report Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applicationDate": "string (date)",
      "applicantZipcode": "integer (int64)",
      "campaignId": "integer (int64)",
      "campaignName": "string",
      "charged": "string",
      "company": "string",
      "downloadUrl": "string",
      "emailAddress": "string",
      "firstName": "string",
      "ipAddress": "string",
      "jobCity": "string",
      "jobReference": "string",
      "jobState": "string",
      "jobZipcode": "integer (int64)",
      "lastName": "string",
      "phone": "string",
      "title": "string"
    }
  ],
  "title": "string"
}

Billing

Create and read payment methods information

GET billing has payment method

GET /billing/hasPaymentMethod

Read if payment information has been provided, at least one payment method (credit card or invoice) is required to advertise with Talroo

customerIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?customerIds=aaa,bbb

Payment Method Verification

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "boolean",
  "title": "string"
}

GET billing list payment methods

GET /billing/listPaymentMethods

Retreive a list of payment methods

customerIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?customerIds=aaa,bbb

Payment Method List

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "invoicesData": [
      {
        "billingCity": "string",
        "billingState": "string",
        "billingStreetAddress": "string",
        "billingZipCode": "string",
        "companyName": "string",
        "contactFullName": "string",
        "createdUtc": "string (date-time)",
        "customerId": "integer (int64)",
        "doingBusinessAsName": "string",
        "emailAddressList": "string",
        "invoiceId": "integer (int64)",
        "isDefault": "integer (int32)",
        "lastUpdatedUtc": "string (date-time)",
        "phoneNumber": "string"
      }
    ],
    "paymentCardsData": [
      {
        "billingCity": "string",
        "billingState": "string",
        "billingStreetAddress1": "string",
        "billingStreetAddress2": "string",
        "billingZipCode": "string",
        "cardType": "string",
        "cardTypeCode": "string",
        "createdUtc": "string (date-time)",
        "customerId": "integer (int64)",
        "emailAddress": "string",
        "expiration": "string",
        "firstName": "string",
        "isDefault": "integer (int32)",
        "lastDigits": "string",
        "lastName": "string",
        "lastUpdatedUtc": "string (date-time)",
        "phoneNumber": "string",
        "token": "string"
      }
    ]
  },
  "title": "string"
}

Campaign

Create, read and update campaign information. Campaigns are collections of jobs

GET campaign report

GET /campaign/report

Read performance data for the provided campaignIds and date range

start: integer (int64)
in query

unix timestamp in milliseconds

end: integer (int64)
in query

unix timestamp in milliseconds

customerIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?customerIds=aaa,bbb
poolIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?poolIds=aaa,bbb
campaignIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?campaignIds=aaa,bbb
Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "campaignId": "integer (int64)",
      "clickDate": "string (date)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "customerId": "integer (int64)",
      "impressions": "integer (int32)",
      "poolId": "integer (int64)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

GET campaign summary

GET /campaign/summary

Read summarized performance data for the provided campaignIds and date range

start: integer (int64)
in query

unix timestamp in milliseconds

end: integer (int64)
in query

unix timestamp in milliseconds

customerIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?customerIds=aaa,bbb
poolIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?poolIds=aaa,bbb
campaignIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?campaignIds=aaa,bbb
Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "impressions": "integer (int32)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

PUT campaign budget

PUT /campaign/budget

Update a campaign's budget allocation, value must be greater than the campaign's spend

campaignId: integer (int64)
in query

campaign ID

budgetCents: integer (int32)
in query

budget in cents, in which -1 means unlimited budget

Put Campaign Budget

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

PUT campaign budget delta

PUT /campaign/budgetDelta

Update a campaign's budget allocation in reference to it's current budget allocation

campaignId: integer (int64)
in query

campaign ID

deltaCents: integer (int32)
in query

delta in cents

Put Campaign Budget Delta

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

GET campaign

GET /campaigns

Read a campaign

customerIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

campaignIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Get Campaign Information

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "budgetCents": "integer (int32)",
      "displayName": "string",
      "emailAddress": "string",
      "hostApplication": "boolean",
      "id": "integer (int64)",
      "isCpa": "boolean",
      "name": "string",
      "poolId": "integer (int64)",
      "spendCents": "integer (int32)",
      "status": "string"
    }
  ],
  "title": "string"
}

Company

Company

GET company

GET /company

Retrieve a list of companies standardized by name

companyId: integer (int64)
in query

company ID

companyName: string
in query

company name

exactMatch: boolean
in query

exact match

Get Company Information

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "id": "integer (int64)",
      "name": "string"
    }
  ],
  "title": "string"
}

Customer

Read customer performance reports and information

GET customer report

GET /customer/report

Read performance data for the provided customerIds and date range

start: integer (int64)
in query

unix timestamp in milliseconds

end: integer (int64)
in query

unix timestamp in milliseconds

customerIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?customerIds=aaa,bbb

Get Customer Report

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "clickDate": "string (date)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "customerId": "integer (int64)",
      "impressions": "integer (int32)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

GET customer summary

GET /customer/summary

Read summarized performance data for the provided customerIds and date range

start: integer (int64)
in query

unix timestamp in milliseconds

end: integer (int64)
in query

unix timestamp in milliseconds

customerIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?customerIds=aaa,bbb

Get Customer Summary

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "impressions": "integer (int32)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

Get customer information

GET /customer

Read customer information

customerIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Get Customers

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "emailAddress": "string",
      "fullName": "string",
      "id": "integer (int64)",
      "name": "string",
      "TermsOfServiceAccepted": "boolean",
      "TermsOfServiceSignDate": "integer (int64)",
      "username": "string"
    }
  ],
  "title": "string"
}

Dashboard

Dashboard

Group

Groups are collections of jobs which share a budget. Group job ads by location, company or other attributes. A job ad may only be inlcuded in one group at any given time

GET group summary

GET /group/summary

Read summarized performance data for a given groupId and date range

start: integer (int64)
in query

unix timestamp in milliseconds

end: integer (int64)
in query

unix timestamp in milliseconds

customerIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?customerIds=aaa,bbb
groupIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?groupIds=aaa,bbb

Get Group Summary

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "impressions": "integer (int32)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

GET group report

GET /group/report

Read performance data for a given groupId and date range

start: integer (int64)
in query

unix timestamp in milliseconds

end: integer (int64)
in query

unix timestamp in milliseconds

customerIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?customerIds=aaa,bbb
groupIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?groupIds=aaa,bbb

Report

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "campaignId": "integer (int64)",
      "clickDate": "string (date)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "customerId": "integer (int64)",
      "groupId": "integer (int64)",
      "impressions": "integer (int32)",
      "poolId": "integer (int64)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

GET group list

GET /groups

Read a list of all groups for a given list of customerId, groupId or campaignId

customerIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?customerIds=aaa,bbb
campaignIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?campaignIds=aaa,bbb
groupIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?groupIds=aaa,bbb

Get Group List

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "autoRenew": "boolean",
      "budgetCents": "integer (int32)",
      "campaignId": "integer (int64)",
      "campaignName": "string",
      "emailAddress": "string",
      "groupId": "integer (int64)",
      "groupName": "string",
      "isCpa": "boolean",
      "jobCount": "integer (int64)",
      "priority": "integer (int32)",
      "spendCents": "integer (int32)",
      "status": "string"
    }
  ],
  "title": "string"
}

PUT group priority minimum

PUT /group/priorityMinimum

Update a group to have the lowest priority. If a job ad matches multiple groups, the job ad will be included in the lowest priority group

campaignId: integer (int64)
in query

campaign ID

groupId: integer (int64)
in query

group ID

Put Group Priority Minimum Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "campaignId": "integer (int64)",
    "groupId": "integer (int64)",
    "operation": "string"
  },
  "title": "string"
}

PUT group priority down

PUT /group/priorityDown

Decrease a group's priority by one

campaignId: integer (int64)
in query

campaign ID

groupId: integer (int64)
in query

group ID

Put Group Priority Down Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "campaignId": "integer (int64)",
    "groupId": "integer (int64)",
    "operation": "string"
  },
  "title": "string"
}

POST group

POST /group

Create a new group

group data

Request Example
{
  "budgetCents": "integer (int32)",
  "campaignId": "integer (int64)",
  "isLive": "boolean",
  "isMonthlyBudget": "boolean",
  "name": "string",
  "configurationCity": "string",
  "configurationQuery": "string",
  "cpaCents": "integer (int32)",
  "defaultCustomBidCents": "integer (int32)",
  "defaultPredictionTier": "integer (int32)",
  "emailAddress": "string",
  "excludeFilters": {
    "accountIds": [
      "string"
    ],
    "companyDetails": [
      "object"
    ],
    "companyIds": [
      "string"
    ],
    "includeFilterDetails": "boolean",
    "industries": [
      "string"
    ],
    "jobDescriptions": [
      "string"
    ],
    "jobStateIds": [
      "string"
    ],
    "jobTitles": [
      "string"
    ],
    "locations": [
      "string"
    ],
    "referenceNumbers": [
      "string"
    ]
  },
  "includeFilters": {
    "accountIds": [
      "string"
    ],
    "companyDetails": [
      "object"
    ],
    "companyIds": [
      "string"
    ],
    "includeFilterDetails": "boolean",
    "industries": [
      "string"
    ],
    "jobDescriptions": [
      "string"
    ],
    "jobStateIds": [
      "string"
    ],
    "jobTitles": [
      "string"
    ],
    "locations": [
      "string"
    ],
    "referenceNumbers": [
      "string"
    ]
  },
  "isUnbind": "boolean",
  "jobtype": "integer (int32)",
  "prependTag": "string",
  "qqMultiplier": "number (float)",
  "registrationCpcCents": "integer (int32)",
  "sponsoredCpcCents": "integer (int32)",
  "trackingTags": "string"
}

POST Group Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "integer (int64)",
  "title": "string"
}

DELETE group

DELETE /group

Delete a group

campaignId: integer (int64)
in query

campaign ID

groupId: integer (int64)
in query

group ID

DELETE Group Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "integer (int32)",
  "title": "string"
}

PUT group detail

PUT /group

Update group configuration

Status Number:
1 - ACTIVE
2 - PAUSED
4 - OUT_OF_BUDGET
5 - TERMINATED

group data

campaignId: integer (int64)
in query

campaign ID

groupId: integer (int64)
in query

group ID

Request Example
{
  "budgetCents": "integer (int32)",
  "configurationCity": "string",
  "configurationQuery": "string",
  "defaultCustomBidCents": "integer (int32)",
  "defaultPredictionTier": "integer (int32)",
  "emailAddress": "string",
  "isMonthlyBudget": "boolean",
  "isSystem": "boolean",
  "isUnbind": "boolean",
  "jobtype": "integer (int32)",
  "lastUpdated": "string (date)",
  "name": "string",
  "prependTag": "string",
  "qqMultiplier": "number (float)",
  "registrationCpcCents": "integer (int32)",
  "status": "integer (int32)",
  "trackingTags": "string"
}

Put Group Details

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

PUT group budget

PUT /group/budget

Update a group's budget

campaignId: integer (int64)
in query

campaign ID

groupId: integer (int64)
in query

group ID

isMonthlyBudget: boolean
in query

is monthly budget or not

budgetCents: integer (int32)
in query

budget in cents, in which -1 means unlimited budget

Put Group Budget

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

PUT group pause

PUT /group/pause

Pause a group

campaignId: integer (int64)
in query

campaign ID

groupId: integer (int64)
in query

group ID

Pause Group Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "integer (int32)",
  "title": "string"
}

PUT group priority maximum

PUT /group/priorityMaximum

Update a group to have the highest priority. If a job ad matches multiple groups, the job ad will be included in the highest priority group

campaignId: integer (int64)
in query

campaign ID

groupId: integer (int64)
in query

group ID

Put Group Priority Maximum Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "campaignId": "integer (int64)",
    "groupId": "integer (int64)",
    "operation": "string"
  },
  "title": "string"
}

PUT group budget delta

PUT /group/budgetDelta

Update a group's budget in reference to it's existing budget

campaignId: integer (int64)
in query

campaign ID

groupId: integer (int64)
in query

group ID

deltaCents: integer (int32)
in query

delta in cents

Put Group Budget Delta

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

PUT group resume

PUT /group/resume

Resume a group

campaignId: integer (int64)
in query

campaign ID

groupId: integer (int64)
in query

group ID

Resume Group Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "integer (int32)",
  "title": "string"
}

PUT group priority up

PUT /group/priorityUp

Increase a group's priority by one

campaignId: integer (int64)
in query

campaign ID

groupId: integer (int64)
in query

group ID

Put Group Priority Up Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "campaignId": "integer (int64)",
    "groupId": "integer (int64)",
    "operation": "string"
  },
  "title": "string"
}

Industry

Industry

GET industry classifications

GET /industry/classifications

GET industry classifications

GET Industry Classifications Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "description": "string",
      "id": "string",
      "indication": "string"
    }
  ],
  "title": "string"
}

POST industry predictions

POST /industry/predictions

POST industry predictions

industry predictions request data

Request Example
{
  "description": "string",
  "jobProperties": {
    "campaignId": "integer (int64)",
    "companyId": "integer (int64)",
    "companyName": "string",
    "groupId": "integer (int64)",
    "sourceId": "integer (int64)"
  },
  "title": "string"
}

GET Industry Predictions Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "majorCategory": "string",
      "majorCategoryScore": "number (double)",
      "minorCategory": "string",
      "minorCategoryScore": "number (double)"
    }
  ],
  "title": "string"
}

GET industry description

GET /industry/description

GET industry description

jobIndustry: string
in query

job industry

GET Industry Description Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "string",
  "title": "string"
}

Job

Job

Job

GET job summary

GET /job/summary

Read summarized performance data for a given job ad

start: integer (int64)
in query

unix timestamp in milliseconds

end: integer (int64)
in query

unix timestamp in milliseconds

campaignId: integer (int64)
in query

campaign ID

referenceNumber: string
in query

reference number

Get Job Summary

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "impressions": "integer (int32)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}
Job

GET job report

GET /job/report

Read a performance report for a given job ad

start: integer (int64)
in query

unix timestamp in milliseconds

end: integer (int64)
in query

unix timestamp in milliseconds

campaignId: integer (int64)
in query

campaign ID

referenceNumber: string
in query

reference number

Get Job Report

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "campaignId": "integer (int64)",
      "clickDate": "string (date)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "customerId": "integer (int64)",
      "groupId": "integer (int64)",
      "impressions": "integer (int32)",
      "jobId": "integer (int64)",
      "poolId": "integer (int64)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}
Job

GET list of jobs

GET /jobs

Read all information for a list of job ads

customerIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?customerIds=aaa,bbb
campaignIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?campaignIds=aaa,bbb
groupIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?groupIds=aaa,bbb
jobIds: string[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?jobIds=aaa,bbb
200 OK

GET Job Details

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "budgetCents": "integer (int32)",
      "campaignId": "integer (int64)",
      "cities": [
        "string"
      ],
      "company": "string",
      "companyId": "integer (int64)",
      "cpcCents": "integer (int32)",
      "created": "string (date-time)",
      "customerId": "integer (int64)",
      "description": "string",
      "email": "string",
      "id": "string",
      "jobReference": "string",
      "jobStatus": "string",
      "majorCategories": {
        "category": "string",
        "score": "number (double)"
      },
      "minorCategories": {
        "category": "string",
        "score": "number (double)"
      },
      "poolId": "integer (int64)",
      "posted": "string (date-time)",
      "registrationCpcCents": "integer (int32)",
      "groupId": "integer (int64)",
      "stateIds": [
        "integer (int32)"
      ],
      "status": "string",
      "title": "string",
      "url": "string",
      "zipcodes": [
        "integer (int32)"
      ]
    }
  ],
  "title": "string"
}
Job

GET list of jobs

GET /job/list

Read all information for a list of job ads

campaignIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?campaignIds=aaa,bbb
groupIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?groupIds=aaa,bbb
jobIds: integer[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?jobIds=aaa,bbb
accountIds: string[]
in query

Comma separated values. e.g. for values 1 through 5: 1,2,3,4,5

Array values passed separated by comma: ?accountIds=aaa,bbb
jobReferences: string[]
in query

Comma separated values. Ex. 'job1,job2,job3'

Array values passed separated by comma: ?jobReferences=aaa,bbb
jobStatuses: string[]
in query

Comma separated values. Ex. 'LIVE, PAUSED'

Array values passed separated by comma: ?jobStatuses=aaa,bbb

GET Job List

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "accountId": "integer (int64)",
      "autoPilotEndDate": "string (date)",
      "autoPilotMaximumPriceCents": "integer (int32)",
      "autoPilotStartDate": "string (date)",
      "budgetCents": "integer (int32)",
      "campaignId": "integer (int64)",
      "company": "string",
      "cpaCents": "integer (int32)",
      "currentSpendCents": "integer (int32)",
      "endDate": "string (date)",
      "groupId": "integer (int64)",
      "isAutoPilot": "boolean",
      "isCpa": "boolean",
      "isMonthlyBudget": "boolean",
      "jobId": "integer (int64)",
      "locations": [
        {
          "city": "string",
          "state": "string",
          "zipcode": "string"
        }
      ],
      "percentage": "number (float)",
      "priceCents": "integer (int32)",
      "remainingCents": "integer (int32)",
      "referenceNumber": "string",
      "spendCents": "integer (int32)",
      "startDate": "string (date)",
      "status": "string",
      "title": "string",
      "totalSpendCents": "string",
      "upd": "string (date-time)"
    }
  ],
  "title": "string"
}
Job

PUT job budget

PUT /job/budget

Update a job ad's budget

campaignId: integer (int64)
in query

campaign ID

referenceNumber: string
in query

reference number

budgetCents: integer (int32)
in query

budget in cents, in which -1 means unlimited budget

Put Job Budget

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}
Job

PUT job pause

PUT /job/pause

Pause a job

campaignId: integer (int64)
in query

campaign ID

referenceNumber: string
in query

reference number

Pause Job Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}
Job

PUT job resume

PUT /job/resume

Resume a job

campaignId: integer (int64)
in query

campaign ID

referenceNumber: string
in query

reference number

Resume Job Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}
Job

PUT job budget delta

PUT /job/budgetDelta

Update a job ad's budget in reference to it's existing budget

campaignId: integer (int64)
in query

campaign ID

referenceNumber: string
in query

reference number

deltaCents: integer (int32)
in query

delta in cents

Put Job Budget Delta

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}
Job

POST job

POST /job

Create a new job ad

job data

campaignId: integer (int64)
in query

campaign ID

Request Example
{
  "budgetCents": "integer (int32)",
  "description": "string",
  "isMonthlyBudget": "boolean",
  "priceCents": "integer (int32)",
  "title": "string",
  "url": "string",
  "accountId": "string",
  "autoPilotEndDate": "string (date)",
  "autoPilotMaximumPriceCents": "integer (int32)",
  "autoPilotStartDate": "string (date)",
  "benefit": "string",
  "company": "string",
  "companyDetail": "string",
  "emailAddress": "string (email)",
  "endDate": "string (date)",
  "isAutoPilot": "boolean",
  "jobLocations": [
    {
      "city": "string",
      "state": "string",
      "zipcode": "string"
    }
  ],
  "pauseJob": "boolean",
  "referenceNumber": "string",
  "requirement": "string",
  "requireResume": "boolean",
  "startDate": "string (date)"
}
200 OK

Create Job Response

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "referenceNumber": "string",
    "statusCode": "string",
    "statusUrl": "string"
  },
  "title": "string"
}
Job

PUT job

PUT /job

Update a job ad's attributes, except for budget

job data

campaignId: integer (int64)
in query

campaign ID

referenceNumber: string
in query

reference number

Request Example
{
  "accountId": "string",
  "autoPilotEndDate": "string (date)",
  "autoPilotMaximumPriceCents": "integer (int32)",
  "autoPilotStartDate": "string (date)",
  "benefit": "string",
  "budgetCents": "integer (int32)",
  "company": "string",
  "companyDetail": "string",
  "description": "string",
  "emailAddress": "string (email)",
  "endDate": "string (date)",
  "isAutoPilot": "boolean",
  "isMonthlyBudget": "boolean",
  "jobLocations": [
    {
      "city": "string",
      "state": "string",
      "zipcode": "string"
    }
  ],
  "priceCents": "integer (int32)",
  "requirement": "string",
  "requireResume": "boolean",
  "startDate": "string (date)",
  "title": "string",
  "url": "string"
}
200 OK

Put Job

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

Location

Location

Old Industry

Old Industry

Pool

Pool

Prediction

Prediction

POST prediction

POST /prediction

POST prediction

object containing the properties to base the prediction on

Request Example
{
  "company": "string",
  "desc": "string",
  "locations": [
    "string"
  ],
  "title": "string"
}

Prediction

Response Content-Types: application/json
Response Example (200 OK)
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "title": "string",
  "jobPredictions": [
    {
      "applications": "integer (int32)",
      "clicks": "integer (int32)",
      "conversionRate": "number (double)",
      "cpa": "number (float)",
      "cpc": "number (float)",
      "impressions": "integer (int32)",
      "suggestedBudget": "number (float)"
    }
  ]
}

Resume

Resume

Text

Text

Tos

Tos

Schema Definitions

DashboardgetJobStatusCounts200: object

Get job status counts

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETDashboardgetJobStatusCountsColumns

GETDashboardgetJobStatusCounts

GETDashboardgetJobStatusCountsColumns
title: string

Job Status Counts

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "count": "integer (int32)",
      "name": "string",
      "status": "integer (int32)"
    }
  ],
  "title": "string"
}

GroupputGroupPriorityDown200: object

Put Group Priority Down Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: PUTGroupputGroupPriorityDownObject
title: string

Decrement Group Priority

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "campaignId": "integer (int64)",
    "groupId": "integer (int64)",
    "operation": "string"
  },
  "title": "string"
}

UserAccountgetUserAccountLogin400: object

Error

documentationUrl: string

http://docs.odt.io/responses/400

code: integer (int32)

400

title: string

Error

error: string

Unable to log in.

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "title": "string",
  "error": "string"
}

CompanygetCompany200: object

Get Company Information

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: GETCompanygetCompanyColumns

GETCompanygetCompany

GETCompanygetCompanyColumns
title: string

Company Information

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "id": "integer (int64)",
      "name": "string"
    }
  ],
  "title": "string"
}

PUTGroupputGroupPriorityMinimumObject: object

New Priority

campaignId: integer (int64)

Campaign Id

groupId: integer (int64)

Group Id

operation: string

Operation

Example
{
  "campaignId": "integer (int64)",
  "groupId": "integer (int64)",
  "operation": "string"
}

POSTJobpostJobObject: object

Status Code

referenceNumber: string

ReferenceNumber

statusCode: string

Status Code

statusUrl: string

Status URL

Example
{
  "referenceNumber": "string",
  "statusCode": "string",
  "statusUrl": "string"
}

GETCampaigngetCampaignListJobIdsColumns: object

columns

referenceNumber: string

Reference Number

status: integer (int32)

Status

Example
{
  "referenceNumber": "string",
  "status": "integer (int32)"
}

PutCompanyputCompanyColumnsColumns: object

columns

id: integer (int64)

Id

name: string

Name

Example
{
  "id": "integer (int64)",
  "name": "string"
}

GETCustomergetCustomerCampaignsColumns: object

columns

budgetCents: BudgetCents

budget in cents, in which -1 means unlimited budget

displayName: string

Customer Name

emailAddress: string

Email Address

hostApplication: boolean

Is Host Application

id: integer (int64)

Campaign Id

isCpa: boolean

Is Cpa

name: string

Name

poolId: integer (int64)

Pool Id

spendCents: integer (int32)

Spending in cents

Example
{
  "budgetCents": "integer (int32)",
  "displayName": "string",
  "emailAddress": "string",
  "hostApplication": "boolean",
  "id": "integer (int64)",
  "isCpa": "boolean",
  "name": "string",
  "poolId": "integer (int64)",
  "spendCents": "integer (int32)"
}

OldIndustrygetMapEitherIndustriesToJobIndustries200: object

Get Map Either Job Industry to Job Industries

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: string[]
string

Job Industry

title: string

Job Industries

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    "string"
  ],
  "title": "string"
}

GroupputGroupResume200: object

Resume Group Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: integer (int32)

Affected Rows

title: string

Resume Group

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "integer (int32)",
  "title": "string"
}

OldIndustrygetMapJobIndustryToOldJobIndustries200: object

Get Map Job Industry to Old Job Industries

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: string[]
string

Old Job Industry

title: string

Old Job Industries

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    "string"
  ],
  "title": "string"
}

PUTGroupputGroupPriorityDownObject: object

New Priority

campaignId: integer (int64)

Campaign Id

groupId: integer (int64)

Group Id

operation: string

Operation

Example
{
  "campaignId": "integer (int64)",
  "groupId": "integer (int64)",
  "operation": "string"
}

OldIndustrypostIndustryPredictions200: object

GET Old Industry Predictions Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: OldJobIndustryPredictionModel

Old Job Industry Predictions

OldJobIndustryPredictionModel
title: string

Old Industry Predictions

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "industry": "string",
      "industryScore": "number (double)"
    }
  ],
  "title": "string"
}

IndustryPredictionsRequestData: object

description: string

description

jobProperties: JobProperties
title: string

title

Example
{
  "description": "string",
  "jobProperties": {
    "campaignId": "integer (int64)",
    "companyId": "integer (int64)",
    "companyName": "string",
    "groupId": "integer (int64)",
    "sourceId": "integer (int64)"
  },
  "title": "string"
}

GroupSuggestion: object

configurationQuery: string

configuration query

displayName: string

display name

jobIds: string[]

types

string
types: string[]

types

string
Example
{
  "configurationQuery": "string",
  "displayName": "string",
  "jobIds": [
    "string"
  ],
  "types": [
    "string"
  ]
}

GETBillinggetBillingListPaymentMethodsObject: object

Example
{
  "invoicesData": [
    {
      "billingCity": "string",
      "billingState": "string",
      "billingStreetAddress": "string",
      "billingZipCode": "string",
      "companyName": "string",
      "contactFullName": "string",
      "createdUtc": "string (date-time)",
      "customerId": "integer (int64)",
      "doingBusinessAsName": "string",
      "emailAddressList": "string",
      "invoiceId": "integer (int64)",
      "isDefault": "integer (int32)",
      "lastUpdatedUtc": "string (date-time)",
      "phoneNumber": "string"
    }
  ],
  "paymentCardsData": [
    {
      "billingCity": "string",
      "billingState": "string",
      "billingStreetAddress1": "string",
      "billingStreetAddress2": "string",
      "billingZipCode": "string",
      "cardType": "string",
      "cardTypeCode": "string",
      "createdUtc": "string (date-time)",
      "customerId": "integer (int64)",
      "emailAddress": "string",
      "expiration": "string",
      "firstName": "string",
      "isDefault": "integer (int32)",
      "lastDigits": "string",
      "lastName": "string",
      "lastUpdatedUtc": "string (date-time)",
      "phoneNumber": "string",
      "token": "string"
    }
  ]
}

GETPoolgetPoolReportColumns: object

columns

applications: integer (int32)

Number of Applications

clickDate: string (date)

Click Date. Format: YYYY-MM-DD

clicks: integer (int32)

Clicks

conversions1: integer (int32)

Conversions1

conversions2: integer (int32)

Conversions2

conversions3: integer (int32)

Conversions3

customerId: integer (int64)

Customer Id

impressions: integer (int32)

Impressions

poolId: integer (int64)

Pool Id

spendCents: integer (int32)

Spend in cents

Example
{
  "applications": "integer (int32)",
  "clickDate": "string (date)",
  "clicks": "integer (int32)",
  "conversions1": "integer (int32)",
  "conversions2": "integer (int32)",
  "conversions3": "integer (int32)",
  "customerId": "integer (int64)",
  "impressions": "integer (int32)",
  "poolId": "integer (int64)",
  "spendCents": "integer (int32)"
}

GETCampaigngetCampaignSummaryColumns: object

columns

applications: integer (int32)

whole numbers: 0-N

clicks: integer (int32)

whole numbers: 0-N

conversions1: integer (int32)

whole numbers: 0-N

conversions2: integer (int32)

whole numbers: 0-N

conversions3: integer (int32)

whole numbers: 0-N

impressions: integer (int32)

whole numbers: 0-N

spendCents: integer (int32)

Spending in cents

Example
{
  "applications": "integer (int32)",
  "clicks": "integer (int32)",
  "conversions1": "integer (int32)",
  "conversions2": "integer (int32)",
  "conversions3": "integer (int32)",
  "impressions": "integer (int32)",
  "spendCents": "integer (int32)"
}

JobgetJobReport200: object

Get Job Report

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: GETJobgetJobReportColumns

GETJobgetJobReport

GETJobgetJobReportColumns
title: string

Job Report

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "campaignId": "integer (int64)",
      "clickDate": "string (date)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "customerId": "integer (int64)",
      "groupId": "integer (int64)",
      "impressions": "integer (int32)",
      "jobId": "integer (int64)",
      "poolId": "integer (int64)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

JobgetJob200: object

GET Job Details

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETJobgetJobColumns

GETJobgetJob

GETJobgetJobColumns
title: string

Job Details

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "accountId": "integer (int64)",
      "autoPilotEndDate": "string (date)",
      "autoPilotMaximumPriceCents": "integer (int32)",
      "autoPilotStartDate": "string (date)",
      "benefit": "string",
      "budgetCents": "integer (int32)",
      "campaign": {
        "displayName": "string",
        "emailAddress": "string",
        "hostApplication": "integer (int32)",
        "id": "integer (int64)",
        "jobCustomerId": "integer (int64)",
        "name": "string",
        "poolId": "integer (int64)",
        "spendCents": "integer (int32)",
        "status": "string"
      },
      "campaignId": "integer (int64)",
      "company": "string",
      "companyDetail": "string",
      "cpaCents": "integer (int32)",
      "currentSpendCents": "integer (int32)",
      "description": "string",
      "emailAddress": "string",
      "endDate": "string (date)",
      "errorMessage": "string",
      "groupId": "integer (int64)",
      "id": "integer (int64)",
      "isAutoPilot": "boolean",
      "isCpa": "boolean",
      "isMonthlyBudget": "boolean",
      "jobId": "integer (int64)",
      "locations": {
        "city": "integer (int64)",
        "state": "string",
        "zipcode": "integer (int64)"
      },
      "priceCents": "integer (int32)",
      "referenceNumber": "string",
      "requirement": "string",
      "spendCents": "integer (int32)",
      "startDate": "string (date)",
      "status": "string",
      "title": "string",
      "totalSpendCents": "integer (int32)",
      "url": "string"
    }
  ],
  "title": "string"
}

CustomergetCustomers200: object

Get Customers

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: GETCustomergetCustomersColumns

GETCustomergetCustomers

GETCustomergetCustomersColumns
title: string

Customers

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "emailAddress": "string",
      "fullName": "string",
      "id": "integer (int64)",
      "name": "string",
      "TermsOfServiceAccepted": "boolean",
      "TermsOfServiceSignDate": "integer (int64)",
      "username": "string"
    }
  ],
  "title": "string"
}

GETGroupgetGroupReportColumns: object

columns

applications: integer (int32)

Number of Applications

campaignId: integer (int64)

Campaign Id

clickDate: string (date)

Click Date. Format: YYYY-MM-DD

clicks: integer (int32)

Clicks

conversions1: integer (int32)

Conversions1

conversions2: integer (int32)

Conversions2

conversions3: integer (int32)

Conversions3

customerId: integer (int64)

Customer Id

groupId: integer (int64)

Group Id

impressions: integer (int32)

Impressions

poolId: integer (int64)

Pool Id

spendCents: integer (int32)

Spending in cents

Example
{
  "applications": "integer (int32)",
  "campaignId": "integer (int64)",
  "clickDate": "string (date)",
  "clicks": "integer (int32)",
  "conversions1": "integer (int32)",
  "conversions2": "integer (int32)",
  "conversions3": "integer (int32)",
  "customerId": "integer (int64)",
  "groupId": "integer (int64)",
  "impressions": "integer (int32)",
  "poolId": "integer (int64)",
  "spendCents": "integer (int32)"
}

GETCampaigngetCampaignBudgetColumns: object

columns

budgetCents: BudgetCents

budget in cents, in which -1 means unlimited budget

id: integer (int64)

Campaign Id

spendCents: integer (int32)

Spending in cents

Example
{
  "budgetCents": "integer (int32)",
  "id": "integer (int64)",
  "spendCents": "integer (int32)"
}

OldIndustrygetIndustryDescription200: object

GET Old Industry Description Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: string

Old Industry Description

title: string

Old Industry Title

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "string",
  "title": "string"
}

GroupgetGroupSummary200: object

Get Group Summary

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: GETGroupgetGroupSummaryColumns

GETGroupgetGroupSummary

GETGroupgetGroupSummaryColumns
title: string

Group Summary

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "impressions": "integer (int32)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

OldJobIndustryClassificationModel: object

description: string

description

id: string

id

Example
{
  "description": "string",
  "id": "string"
}

GroupSuggesterResult: object

groupSuggestions: GroupSuggestion

Group Suggestion

GroupSuggestion
notFoundJobIds: string[]

Not Found Job Ids

string
Example
{
  "groupSuggestions": [
    {
      "configurationQuery": "string",
      "displayName": "string",
      "jobIds": [
        "string"
      ],
      "types": [
        "string"
      ]
    }
  ],
  "notFoundJobIds": [
    "string"
  ]
}

JobgetJobBudget200: object

GET Job Budget

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETJobgetJobBudgetColumns

GETJobgetJobBudget

GETJobgetJobBudgetColumns
title: string

Job Budget

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "budgetCents": "integer (int32)",
      "isMonthlyBudget": "boolean"
    }
  ],
  "title": "string"
}

GETJobgetJobStatusColumns: object

columns

currentMonthSpendCents: integer (int32)

Current Month Spending in cents

isMonthlyBudget: boolean

Is Monthly Budget

status: string

Status

totalSpendCents: integer (int32)

Total Spending in cents

Example
{
  "currentMonthSpendCents": "integer (int32)",
  "isMonthlyBudget": "boolean",
  "status": "string",
  "totalSpendCents": "integer (int32)"
}

GetJobLocationsColumns: object

columns

city: integer (int64)

City

state: string

State

zipcode: integer (int64)

Location Zipcode

Example
{
  "city": "integer (int64)",
  "state": "string",
  "zipcode": "integer (int64)"
}

PhoneNumberUse: string

string PHONE, ALTERNATE_PHONE, FAX, HOME, MOBILE, WORK

GroupputGroupPriorityMinimum200: object

Put Group Priority Minimum Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: PUTGroupputGroupPriorityMinimumObject
title: string

Decrement Group Priority

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "campaignId": "integer (int64)",
    "groupId": "integer (int64)",
    "operation": "string"
  },
  "title": "string"
}

CampaignputCampaignBudgetDelta200: object

Put Campaign Budget Delta

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: PutCampaignputCampaignBudgetDeltaResponseColumns
title: string

Campaign Budget

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

PermissionsCampaignLevel: object

SUPER_ADMINISTRATOR: integer[]

The campaign ids that this User Account has SUPER_ADMINISTRATOR privilege on

integer (int64)

Campaign IDs

ADMINISTRATOR: integer[]

The campaign ids that this User Account has ADMINISTRATOR privilege on

integer (int64)

Campaign IDs

NORMAL: integer[]

The campaign ids that this User Account has NORMAL privilege on

integer (int64)

Campaign IDs

READER: integer[]

The campaign ids that this User Account has READER privilege on

integer (int64)

Campaign IDs

Example
{
  "SUPER_ADMINISTRATOR": [
    "integer (int64)"
  ],
  "ADMINISTRATOR": [
    "integer (int64)"
  ],
  "NORMAL": [
    "integer (int64)"
  ],
  "READER": [
    "integer (int64)"
  ]
}

GETCampaigngetCampaignColumns: object

columns

budgetCents: BudgetCents

budget in cents, in which -1 means unlimited budget

displayName: string

Customer Name

emailAddress: string

Email Address

hostApplication: boolean

Is Host Application

id: integer (int64)

Campaign Id

isCpa: boolean

Is CPA

name: string

Campaign Name

poolId: integer (int64)

Pool Id

spendCents: integer (int32)

Spending in cents

status: string

Status

Example
{
  "budgetCents": "integer (int32)",
  "displayName": "string",
  "emailAddress": "string",
  "hostApplication": "boolean",
  "id": "integer (int64)",
  "isCpa": "boolean",
  "name": "string",
  "poolId": "integer (int64)",
  "spendCents": "integer (int32)",
  "status": "string"
}

CampaignId: integer

Campaign ID

Example
"integer (int64)"

PoolgetPoolReport200: object

Get Pool Report

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETPoolgetPoolReportColumns

GETPoolgetPoolReport

GETPoolgetPoolReportColumns
title: string

Pool Report

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "clickDate": "string (date)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "customerId": "integer (int64)",
      "impressions": "integer (int32)",
      "poolId": "integer (int64)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

BudgetCents: integer

budget in cents, in which -1 means unlimited budget

Example
"integer (int32)"

GroupgetGroupList200: object

Get Group List

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETGroupgetGroupListColumns

GETGroupgetGroupList

GETGroupgetGroupListColumns
title: string

Groups

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "autoRenew": "boolean",
      "budgetCents": "integer (int32)",
      "campaignId": "integer (int64)",
      "campaignName": "string",
      "emailAddress": "string",
      "groupId": "integer (int64)",
      "groupName": "string",
      "isCpa": "boolean",
      "jobCount": "integer (int64)",
      "priority": "integer (int32)",
      "spendCents": "integer (int32)",
      "status": "string"
    }
  ],
  "title": "string"
}

PutJobputJobBudgetDeltaResponseColumns: object

columns

statusCode: string

Status Code

Example
{
  "statusCode": "string"
}

BillPaymentCardReceiptParameters: object

parameters

object[]

parameter

object
Example
"object"

TableResponse: object

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: TableResponseColumns

TableResponse

TableResponseColumns
title: string
Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    "object"
  ],
  "title": "string"
}

DashboardgetRemainingBudget200: object

Get a sum of the remaining budget amounts for jobs

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETDashboardgetRemainingBudgetColumns

GETDashboardgetRemainingBudget

GETDashboardgetRemainingBudgetColumns
title: string

Remaining Budget

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "remainingCents": "integer (int32)"
    }
  ],
  "title": "string"
}

CustomergetCustomerCampaigns200: object

Get Customer Campaigns

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETCustomergetCustomerCampaignsColumns

GETCustomergetCustomerCampaigns

GETCustomergetCustomerCampaignsColumns
title: string

Customer Campaigns

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "budgetCents": "integer (int32)",
      "displayName": "string",
      "emailAddress": "string",
      "hostApplication": "boolean",
      "id": "integer (int64)",
      "isCpa": "boolean",
      "name": "string",
      "poolId": "integer (int64)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

IndustrypostIndustryPredictions200: object

GET Industry Predictions Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: JobIndustryPredictionModel

Job Industry Predictions

JobIndustryPredictionModel
title: string

Industry Predictions

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "majorCategory": "string",
      "majorCategoryScore": "number (double)",
      "minorCategory": "string",
      "minorCategoryScore": "number (double)"
    }
  ],
  "title": "string"
}

GETCampaigngetCampaignReportColumns: object

columns

applications: integer (int32)

Number of Applications

campaignId: integer (int64)

Campaign Id

clickDate: string (date)

Click Date. Format: YYYY-MM-DD

clicks: integer (int32)

Clicks

conversions1: integer (int32)

Conversions1

conversions2: integer (int32)

Conversions2

conversions3: integer (int32)

Conversions3

customerId: integer (int64)

Customer Id

impressions: integer (int32)

Impressions

poolId: integer (int64)

Pool Id

spendCents: integer (int32)

Spending in cents

Example
{
  "applications": "integer (int32)",
  "campaignId": "integer (int64)",
  "clickDate": "string (date)",
  "clicks": "integer (int32)",
  "conversions1": "integer (int32)",
  "conversions2": "integer (int32)",
  "conversions3": "integer (int32)",
  "customerId": "integer (int64)",
  "impressions": "integer (int32)",
  "poolId": "integer (int64)",
  "spendCents": "integer (int32)"
}

CustomergetCustomerOdtCampaigns200: object

Get Customer Talroo Campaigns

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETCustomergetCustomerOdtCampaignsColumns

GETCustomergetCustomerOdtCampaigns

GETCustomergetCustomerOdtCampaignsColumns
title: string
Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    "object"
  ],
  "title": "string"
}

IndustrygetIndustryDescription200: object

GET Industry Description Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: string

Industry Description

title: string

Industry Description

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "string",
  "title": "string"
}

PhoneNumber: object

phoneNumber: string

phone number

phoneNumberSubtype: PhoneNumberSubtype
phoneNumberUse: PhoneNumberUse
Example
{
  "phoneNumber": "string",
  "phoneNumberSubtype": "string",
  "phoneNumberUse": "string"
}

LocationgetLocationAutoComplete200: object

Get Location Auto Complete Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: string[]
string

Term

title: string

Terms

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    "string"
  ],
  "title": "string"
}

GETDashboardgetJobStatusCountsColumns: object

columns

count: integer (int32)

Job Count

name: string

Job Name

status: integer (int32)

Status

Example
{
  "count": "integer (int32)",
  "name": "string",
  "status": "integer (int32)"
}

GroupgetGroups200: object

Get Group List

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: GETGroupgetGroupsColumns

GETGroupgetGroups

GETGroupgetGroupsColumns
title: string

Groups

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "autoRenew": "boolean",
      "budgetCents": "integer (int32)",
      "campaignId": "integer (int64)",
      "campaignName": "string",
      "emailAddress": "string",
      "groupId": "integer (int64)",
      "groupName": "string",
      "isCpa": "boolean",
      "jobCount": "integer (int64)",
      "priority": "integer (int32)",
      "spendCents": "integer (int32)",
      "status": "string"
    }
  ],
  "title": "string"
}

GETPoolgetPoolSummaryColumns: object

columns

applications: integer (int32)

Number of Applications

clicks: integer (int32)

Clicks

conversions1: integer (int32)

Conversions1

conversions2: integer (int32)

Conversions2

conversions3: integer (int32)

Conversions3

impressions: integer (int32)

Impressions

spendCents: integer (int32)

Spend in cents

Example
{
  "applications": "integer (int32)",
  "clicks": "integer (int32)",
  "conversions1": "integer (int32)",
  "conversions2": "integer (int32)",
  "conversions3": "integer (int32)",
  "impressions": "integer (int32)",
  "spendCents": "integer (int32)"
}

GETCustomergetCustomerAccountInformationColumns: object

columns

accountAgentId: integer (int64)

Account Agent Id

accountExecutiveId: integer (int64)

Account Executive Id

accountManagerId: integer (int64)

Account Manager Id

cpaBitmap: integer (int32)

CPA Bit Map

emailAddress: string

Email Address

name: string

Name

salesforceAccountId: integer (int64)

Salesforce Account Id

Example
{
  "accountAgentId": "integer (int64)",
  "accountExecutiveId": "integer (int64)",
  "accountManagerId": "integer (int64)",
  "cpaBitmap": "integer (int32)",
  "emailAddress": "string",
  "name": "string",
  "salesforceAccountId": "integer (int64)"
}

UserAccountgetUserAccountLogin200: object

Token

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

title: string

token

message: string

JSON Web Token

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "title": "string",
  "message": "string"
}

UserAccountgetEffectivePermissions200: object

Token

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

title: string

token

data: GETUserAccountgetEffectivePermissionsObject
Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "title": "string",
  "data": {
    "CAMPAIGN": {
      "SUPER_ADMINISTRATOR": [
        "integer (int64)"
      ],
      "ADMINISTRATOR": [
        "integer (int64)"
      ],
      "NORMAL": [
        "integer (int64)"
      ],
      "READER": [
        "integer (int64)"
      ]
    },
    "CUSTOMER": {
      "SUPER_ADMINISTRATOR": [
        "integer (int64)"
      ],
      "ADMINISTRATOR": [
        "integer (int64)"
      ],
      "NORMAL": [
        "integer (int64)"
      ],
      "READER": [
        "integer (int64)"
      ]
    },
    "GROUP": {
      "SUPER_ADMINISTRATOR": [
        "integer (int64)"
      ],
      "ADMINISTRATOR": [
        "integer (int64)"
      ],
      "NORMAL": [
        "integer (int64)"
      ],
      "READER": [
        "integer (int64)"
      ]
    }
  }
}

TruncatedGroupData: object

budgetCents: BudgetCents

budget in cents, in which -1 means unlimited budget

configurationCity: string

configuration city

configurationQuery: string

configuration query

defaultCustomBidCents: integer (int32)

default custom bid in cents

defaultPredictionTier: integer (int32)

default prediction tier

emailAddress: string

E-mail address

isMonthlyBudget: boolean

is monthly budget

isSystem: boolean

is system

isUnbind: boolean

is unbind

jobtype: integer (int32)

jobtype

lastUpdated: string (date)

last updated

name: string

name

prependTag: string

prepend tag

qqMultiplier: number (float)

qq multiplier

registrationCpcCents: integer (int32)

registration CPC in cents

status: integer (int32)

status

trackingTags: string

tracking tags

Example
{
  "budgetCents": "integer (int32)",
  "configurationCity": "string",
  "configurationQuery": "string",
  "defaultCustomBidCents": "integer (int32)",
  "defaultPredictionTier": "integer (int32)",
  "emailAddress": "string",
  "isMonthlyBudget": "boolean",
  "isSystem": "boolean",
  "isUnbind": "boolean",
  "jobtype": "integer (int32)",
  "lastUpdated": "string (date)",
  "name": "string",
  "prependTag": "string",
  "qqMultiplier": "number (float)",
  "registrationCpcCents": "integer (int32)",
  "status": "integer (int32)",
  "trackingTags": "string"
}

CampaigngetCampaignStatus200: object

Get Campaign Status

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETCampaigngetCampaignStatusColumns

GETCampaigngetCampaignStatus

GETCampaigngetCampaignStatusColumns
title: string

Campaign Status

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "status": "integer (int32)"
    }
  ],
  "title": "string"
}

ApplicationgetApplicationReport200: object

Application Report Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: GETApplicationgetApplicationReportColumns

GETApplicationgetApplicationReport

GETApplicationgetApplicationReportColumns
title: string

Application Download

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applicationDate": "string (date)",
      "applicantZipcode": "integer (int64)",
      "campaignId": "integer (int64)",
      "campaignName": "string",
      "charged": "string",
      "company": "string",
      "downloadUrl": "string",
      "emailAddress": "string",
      "firstName": "string",
      "ipAddress": "string",
      "jobCity": "string",
      "jobReference": "string",
      "jobState": "string",
      "jobZipcode": "integer (int64)",
      "lastName": "string",
      "phone": "string",
      "title": "string"
    }
  ],
  "title": "string"
}

GETCompanygetCompanyColumns: object

columns

id: integer (int64)

Id

name: string

Name

Example
{
  "id": "integer (int64)",
  "name": "string"
}

PermissionsCustomerLevel: object

SUPER_ADMINISTRATOR: integer[]

The customer ids that this User Account has SUPER_ADMINISTRATOR privilege on

integer (int64)

Customer IDs

ADMINISTRATOR: integer[]

The customer ids that this User Account has ADMINISTRATOR privilege on

integer (int64)

Customer IDs

NORMAL: integer[]

The customer ids that this User Account has NORMAL privilege on

integer (int64)

Customer IDs

READER: integer[]

The customer ids that this User Account has READER privilege on

integer (int64)

Customer IDs

Example
{
  "SUPER_ADMINISTRATOR": [
    "integer (int64)"
  ],
  "ADMINISTRATOR": [
    "integer (int64)"
  ],
  "NORMAL": [
    "integer (int64)"
  ],
  "READER": [
    "integer (int64)"
  ]
}

CampaignpostCampaign200: object

Generated Campaign Id

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: integer (int64)

Campaign Id

title: string

Create Campaign

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "integer (int64)",
  "title": "string"
}

CampaigngetCampaignSummary200: object

Summary

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETCampaigngetCampaignSummaryColumns

GETCampaigngetCampaignSummary

GETCampaigngetCampaignSummaryColumns
title: string
Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "impressions": "integer (int32)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

PutGroupputGroupBudgetDeltaResponseColumns: object

columns

statusCode: string

Status Code

Example
{
  "statusCode": "string"
}

GroupputGroupBudgetDelta200: object

Put Group Budget Delta

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: PutGroupputGroupBudgetDeltaResponseColumns
title: string

Group Budget Delta

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

PredictionpostPrediction200: object

Prediction

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

title: string

Job Predictions

jobPredictions: Prediction

job predictions

Prediction
Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "title": "string",
  "jobPredictions": [
    {
      "applications": "integer (int32)",
      "clicks": "integer (int32)",
      "conversionRate": "number (double)",
      "cpa": "number (float)",
      "cpc": "number (float)",
      "impressions": "integer (int32)",
      "suggestedBudget": "number (float)"
    }
  ]
}

TextData: object

text: string

text

textProcessingOptions: TextProcessingOptions
Example
{
  "text": "string",
  "textProcessingOptions": {
    "processPunctuation": "boolean",
    "processStem": "boolean",
    "processStopWords": "boolean",
    "processSynonyms": "boolean"
  }
}

JobputJob200: object

Put Job

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: PutJobputJobResponseColumns
title: string

Update Job

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

JobgetJobList200: object

GET Job List

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETJobgetJobListColumns

GETJobgetJobList

GETJobgetJobListColumns
title: string

Job List

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "accountId": "integer (int64)",
      "autoPilotEndDate": "string (date)",
      "autoPilotMaximumPriceCents": "integer (int32)",
      "autoPilotStartDate": "string (date)",
      "budgetCents": "integer (int32)",
      "campaignId": "integer (int64)",
      "company": "string",
      "cpaCents": "integer (int32)",
      "currentSpendCents": "integer (int32)",
      "endDate": "string (date)",
      "groupId": "integer (int64)",
      "isAutoPilot": "boolean",
      "isCpa": "boolean",
      "isMonthlyBudget": "boolean",
      "jobId": "integer (int64)",
      "locations": [
        {
          "city": "string",
          "state": "string",
          "zipcode": "string"
        }
      ],
      "percentage": "number (float)",
      "priceCents": "integer (int32)",
      "remainingCents": "integer (int32)",
      "referenceNumber": "string",
      "spendCents": "integer (int32)",
      "startDate": "string (date)",
      "status": "string",
      "title": "string",
      "totalSpendCents": "string",
      "upd": "string (date-time)"
    }
  ],
  "title": "string"
}

ApplicationgetApplicationDownload200: object

Application Download Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: string file

File Downloaded

title: string

Application Download

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "string",
  "title": "string"
}

GETCustomergetCustomerOdtCampaignsColumns: object

columns

Example
"object"

JobputJobStatus200: object

Put Job Status

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: PutJobputJobStatusResponseColumns
title: string

Update Job Status

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

BillingPaymentCardSignature: object

parameters

string

parameter

Example
"object"

PoolId: integer

Example
"integer (int64)"

Prediction: object

applications: integer (int32)

applications

clicks: integer (int32)

clicks

conversionRate: number (double)

conversion rate

cpa: number (float)

cpa

cpc: number (float)

cpc

impressions: integer (int32)

impressions

suggestedBudget: number (float)

suggested budget

Example
{
  "applications": "integer (int32)",
  "clicks": "integer (int32)",
  "conversionRate": "number (double)",
  "cpa": "number (float)",
  "cpc": "number (float)",
  "impressions": "integer (int32)",
  "suggestedBudget": "number (float)"
}

OldIndustrygetMapOldJobIndustryToJobIndustries200: object

Get Map Old Job Industry to Job Industries

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: string[]
string

Job Industry

title: string

Job Industries

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    "string"
  ],
  "title": "string"
}

OldIndustrygetOldIndustryClassifications200: object

GET Old Industry Classifications Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: OldJobIndustryClassificationModel

Old Job Industry Classifications

OldJobIndustryClassificationModel
title: string

Old Industry Classifications

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "description": "string",
      "id": "string"
    }
  ],
  "title": "string"
}

TextpostTextProcess200: object

POST Text Process

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: string

Tokens

title: string

Text

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "string",
  "title": "string"
}

StandardSummaryResponseSchemaColumns: object

columns

applications: integer (int32)

Number of Applications

clicks: integer (int32)

Clicks

conversions1: integer (int32)

Conversions1

conversions2: integer (int32)

Conversions2

conversions3: integer (int32)

Conversions3

impressions: integer (int32)

Impressions

spendCents: integer (int32)

Spending in cents

Example
{
  "applications": "integer (int32)",
  "clicks": "integer (int32)",
  "conversions1": "integer (int32)",
  "conversions2": "integer (int32)",
  "conversions3": "integer (int32)",
  "impressions": "integer (int32)",
  "spendCents": "integer (int32)"
}

CampaigngetCampaignListJobIds200: object

Get Campaign List Job ID's

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETCampaigngetCampaignListJobIdsColumns

GETCampaigngetCampaignListJobIds

GETCampaigngetCampaignListJobIdsColumns
title: string

Job ID's

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "referenceNumber": "string",
      "status": "integer (int32)"
    }
  ],
  "title": "string"
}

GrouppostGroupFilterSuggestions200: object

POST Group Filter Suggestions

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: GroupSuggesterResult
title: string

Group Suggester Result

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "groupSuggestions": [
      {
        "configurationQuery": "string",
        "displayName": "string",
        "jobIds": [
          "string"
        ],
        "types": [
          "string"
        ]
      }
    ],
    "notFoundJobIds": [
      "string"
    ]
  },
  "title": "string"
}

JobpostJob200: object

Create Job Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: POSTJobpostJobObject
title: string

Create Job

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "referenceNumber": "string",
    "statusCode": "string",
    "statusUrl": "string"
  },
  "title": "string"
}

GroupgetGroupJobs200: object

Get Group Jobs

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETGroupgetGroupJobsColumns

GETGroupgetGroupJobs

GETGroupgetGroupJobsColumns
title: string

Group Jobs

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "accountId": "integer (int64)",
      "autoPilotEndDate": "string (date)",
      "autoPilotMaxPriceCents": "integer (int32)",
      "autoPilotStartDate": "string (date)",
      "budgetCents": "integer (int32)",
      "campaignId": "integer (int64)",
      "city": "integer (int64)",
      "company": "string",
      "cpa": "number (float)",
      "endDate": "string (date)",
      "groupId": "integer (int64)",
      "isAutoPilot": "boolean",
      "isCpa": "boolean",
      "isMonthlyBudget": "boolean",
      "jobId": "integer (int64)",
      "locations": [
        {
          "city": "string",
          "state": "string",
          "zipcode": "string"
        }
      ],
      "priceCents": "integer (int32)",
      "referenceNumber": "string",
      "remainingCents": "integer (int32)",
      "spendCents": "integer (int32)",
      "startDate": "string (date)",
      "state": "string",
      "status": "string",
      "title": "string",
      "upd": "string (date-time)",
      "zipcode": "integer (int64)"
    }
  ],
  "title": "string"
}

GETCampaigngetCampaignBudgetsColumns: object

columns

budgetCents: BudgetCents

budget in cents, in which -1 means unlimited budget

id: integer (int64)

Campaign Id

spendCents: integer (int32)

Spending in cents

Example
{
  "budgetCents": "integer (int32)",
  "id": "integer (int64)",
  "spendCents": "integer (int32)"
}

CampaigngetCampaign200: object

Get Campaign Information

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: GETCampaigngetCampaignColumns

GETCampaigngetCampaign

GETCampaigngetCampaignColumns
title: string

Campaign

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "budgetCents": "integer (int32)",
      "displayName": "string",
      "emailAddress": "string",
      "hostApplication": "boolean",
      "id": "integer (int64)",
      "isCpa": "boolean",
      "name": "string",
      "poolId": "integer (int64)",
      "spendCents": "integer (int32)",
      "status": "string"
    }
  ],
  "title": "string"
}

IndustrygetIndustryClassifications200: object

GET Industry Classifications Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: JobIndustryClassificationModel

Job Industry Classifications

JobIndustryClassificationModel
title: string

Industry Classifications

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "description": "string",
      "id": "string",
      "indication": "string"
    }
  ],
  "title": "string"
}

CustomergetCustomerOdtReport200: object

Get Customer Talroo Report

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETCustomergetCustomerOdtReportColumns

GETCustomergetCustomerOdtReport

GETCustomergetCustomerOdtReportColumns
title: string

Customer Talroo Report

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "clickDate": "string (date)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "impressions": "integer (int32)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

StandardSummaryResponseSchema: object

Summary Response Schema

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: StandardSummaryResponseSchemaColumns

Summary Response Schema

StandardSummaryResponseSchemaColumns
title: string
Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "impressions": "integer (int32)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

GETGroupgetGroupStatusColumns: object

columns

campaignId: integer (int64)

Campaign Id

groupId: integer (int64)

Group Id

status: string

Status

Example
{
  "campaignId": "integer (int64)",
  "groupId": "integer (int64)",
  "status": "string"
}

BillinggetBillingHasPaymentMethod200: object

Payment Method Verification

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: boolean

Has Payment Method

title: string

Payment Method Verification

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "boolean",
  "title": "string"
}

GETGroupgetGroupJobsColumns: object

columns

accountId: integer (int64)

Account Id

autoPilotEndDate: string (date)

AutoPilot End Date

autoPilotMaxPriceCents: integer (int32)

AutoPilot Max Price in cents

autoPilotStartDate: string (date)

AutoPilot Start Date

budgetCents: BudgetCents

budget in cents, in which -1 means unlimited budget

campaignId: integer (int64)

Campaign Id

city: integer (int64)

City

company: string

Company

cpa: number (float)

CPA

endDate: string (date)

End Date

groupId: integer (int64)

Group Id

isAutoPilot: boolean

Is AutoPilot

isCpa: boolean

Is Cpa

isMonthlyBudget: boolean

Is Monthly Budget

jobId: integer (int64)

Job Id

locations: JobLocation

Locations

JobLocation
priceCents: integer (int32)

Price in cents

referenceNumber: string

Reference Number

remainingCents: integer (int32)

Remaining Budget in cents

spendCents: integer (int32)

Spending in cents

startDate: string (date)

Start Date

state: string

State

status: string

Status

title: string

Title

upd: string (date-time)

Update Time

zipcode: integer (int64)

Location Zipcode

Example
{
  "accountId": "integer (int64)",
  "autoPilotEndDate": "string (date)",
  "autoPilotMaxPriceCents": "integer (int32)",
  "autoPilotStartDate": "string (date)",
  "budgetCents": "integer (int32)",
  "campaignId": "integer (int64)",
  "city": "integer (int64)",
  "company": "string",
  "cpa": "number (float)",
  "endDate": "string (date)",
  "groupId": "integer (int64)",
  "isAutoPilot": "boolean",
  "isCpa": "boolean",
  "isMonthlyBudget": "boolean",
  "jobId": "integer (int64)",
  "locations": [
    {
      "city": "string",
      "state": "string",
      "zipcode": "string"
    }
  ],
  "priceCents": "integer (int32)",
  "referenceNumber": "string",
  "remainingCents": "integer (int32)",
  "spendCents": "integer (int32)",
  "startDate": "string (date)",
  "state": "string",
  "status": "string",
  "title": "string",
  "upd": "string (date-time)",
  "zipcode": "integer (int64)"
}

TextPrediction: object

category: string

category

score: number (double)

score

Example
{
  "category": "string",
  "score": "number (double)"
}

CustomergetCustomerOdtSummary200: object

Get Customer Talroo Summary

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETCustomergetCustomerOdtSummaryColumns

GETCustomergetCustomerOdtSummary

GETCustomergetCustomerOdtSummaryColumns
title: string

Customer Talroo Summary

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "impressions": "integer (int32)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

JobgetJobSpendingMonthly200: object

GET Job Monthly Spending

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETJobgetJobSpendingMonthlyColumns

GETJobgetJobSpendingMonthly

GETJobgetJobSpendingMonthlyColumns
title: string

Job Monthly Spending

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "monthlySpendCents": "integer (int32)",
      "month": "string"
    }
  ],
  "title": "string"
}

CampaigngetCampaignReport200: object

Report

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: GETCampaigngetCampaignReportColumns

GETCampaigngetCampaignReport

GETCampaigngetCampaignReportColumns
title: string

Campaign Report

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "campaignId": "integer (int64)",
      "clickDate": "string (date)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "customerId": "integer (int64)",
      "impressions": "integer (int32)",
      "poolId": "integer (int64)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

GETCustomergetCustomerOdtSummaryColumns: object

columns

applications: integer (int32)

Number of Applications

clicks: integer (int32)

Clicks

conversions1: integer (int32)

Conversions1

conversions2: integer (int32)

Conversions2

conversions3: integer (int32)

Conversions3

impressions: integer (int32)

Impressions

spendCents: integer (int32)

Spending in cents

Example
{
  "applications": "integer (int32)",
  "clicks": "integer (int32)",
  "conversions1": "integer (int32)",
  "conversions2": "integer (int32)",
  "conversions3": "integer (int32)",
  "impressions": "integer (int32)",
  "spendCents": "integer (int32)"
}

PUTCompanyputCompanyObject: object

Status Code

details: PutCompanyputCompanyColumns
statusCode: string

Status Code

Example
{
  "details": {
    "id": "integer (int64)",
    "name": "string"
  },
  "statusCode": "string"
}

GETJobgetJobColumns: object

columns

accountId: integer (int64)

Account Id

autoPilotEndDate: string (date)

AutoPilot End Date

autoPilotMaximumPriceCents: integer (int32)

AutoPilot Maximum Price in cents

autoPilotStartDate: string (date)

AutoPilotStart Date

benefit: string

Benefit

budgetCents: BudgetCents

budget in cents, in which -1 means unlimited budget

campaign: GetJobCampaignColumns
campaignId: integer (int64)

Campaign Id

company: string

Company

companyDetail: string

Company Detail

cpaCents: integer (int32)

CPA in cents

currentSpendCents: integer (int32)

Current Spending in cents

description: string

Job Description

emailAddress: string

Email Address

endDate: string (date)

End Date

errorMessage: string

Error Message

groupId: integer (int64)

Group Id

id: integer (int64)

FR Job Id

isAutoPilot: boolean

Is AutoPilot

isCpa: boolean

Is Cpa

isMonthlyBudget: boolean

Is Monthly Budget

jobId: integer (int64)

Job Id

locations: GetJobLocationsColumns
priceCents: integer (int32)

Price in cents

referenceNumber: string

Reference Number

requirement: string

Requirement

spendCents: integer (int32)

Spending in cents

startDate: string (date)

Start Date

status: string

Status

title: string

Job Title

totalSpendCents: integer (int32)

Total Spending in cents

url: string

URL

Example
{
  "accountId": "integer (int64)",
  "autoPilotEndDate": "string (date)",
  "autoPilotMaximumPriceCents": "integer (int32)",
  "autoPilotStartDate": "string (date)",
  "benefit": "string",
  "budgetCents": "integer (int32)",
  "campaign": {
    "displayName": "string",
    "emailAddress": "string",
    "hostApplication": "integer (int32)",
    "id": "integer (int64)",
    "jobCustomerId": "integer (int64)",
    "name": "string",
    "poolId": "integer (int64)",
    "spendCents": "integer (int32)",
    "status": "string"
  },
  "campaignId": "integer (int64)",
  "company": "string",
  "companyDetail": "string",
  "cpaCents": "integer (int32)",
  "currentSpendCents": "integer (int32)",
  "description": "string",
  "emailAddress": "string",
  "endDate": "string (date)",
  "errorMessage": "string",
  "groupId": "integer (int64)",
  "id": "integer (int64)",
  "isAutoPilot": "boolean",
  "isCpa": "boolean",
  "isMonthlyBudget": "boolean",
  "jobId": "integer (int64)",
  "locations": {
    "city": "integer (int64)",
    "state": "string",
    "zipcode": "integer (int64)"
  },
  "priceCents": "integer (int32)",
  "referenceNumber": "string",
  "requirement": "string",
  "spendCents": "integer (int32)",
  "startDate": "string (date)",
  "status": "string",
  "title": "string",
  "totalSpendCents": "integer (int32)",
  "url": "string"
}

GroupgetGroupBudget200: object

Get Group Budget Response

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETGroupgetGroupBudgetColumns

GETGroupgetGroupBudget

GETGroupgetGroupBudgetColumns
title: string

Group Budget

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "budgetCents": "integer (int32)",
      "isMonthlyBudget": "boolean",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

CampaignData: object

alarmed: integer (int32)

alarmed

applicationCallbackUrl: string

application callback URL

applyOrder: integer (int32)

apply order

atsId: integer (int32)

Application Tracking System (ATS) ID

budgetPacing: integer (int32)

budget pacing

billingType: string

billing type

budgetCents: BudgetCents

budget in cents, in which -1 means unlimited budget

campaignId: CampaignId
commissionPercent: integer (int32)

commission percent

configurationCity: string

configuration city

configurationQuery: string

configuration query

cpaCents: integer (int32)

CPA in cents

dailyCapped: integer (int32)

daily capped

dailyCappedTime: string (date-time)

daily capped time

dailyCapPublisherExclusion: integer (int32)

daily cap publisher exclusion

dailyCapResetTime: string (date-time)

daily cap reset time

defaultCpcCents: integer (int32)

Default Cpc in cents

displayName: string

display name

emailAddress: string

E-mail address

excludeAffiliate: string

exclude affiliate

excludeAffiliateFeed: string

exclude affiliate feed

excludeHighQualityScoreAffiliate: string

exclude high quality score (QS) affiliate

exportSingleJob: integer (int32)

export single job

frJobsLoaded: integer (int32)

Federal Reserve (FR) jobs loaded

hostApplication: integer (int32)

host application

hostApplicationRedirect: integer (int32)

host application redirect

isEnhanceBidding: boolean

is enhance bidding

jobsLoaded: integer (int32)

jobs loaded

jobType: integer (int32)

job type

lastUpdated: string (date)

last updated

mobileFriendly: integer (int32)

mobile friendly

name: string

name

noQualityScoreAdjustmentAllowed: integer (int32)

no quality score (QS) adjustment allowed

optoutEmail: integer (int32)

optout E-mail

pacingDom: integer (int32)

pacing DOM

pending: integer (int32)

pending

poolId: PoolId
prependTag: string

prepend tag

qqMultiplier: number (float)

qq multiplier

registrationCpcCents: integer (int32)

Registration Cpc in cents

requireResume: integer (int32)

require resume

resumeMatch: number (float)

resume match

spendCents: integer (int32)

Spending in cents

spendThreshold: integer (int32)

spending threshold

status: integer (int32)

status

trackingTags: string

tracking tags

usOnly: integer (int32)

US only

Example
{
  "alarmed": "integer (int32)",
  "applicationCallbackUrl": "string",
  "applyOrder": "integer (int32)",
  "atsId": "integer (int32)",
  "budgetPacing": "integer (int32)",
  "billingType": "string",
  "budgetCents": "integer (int32)",
  "campaignId": "integer (int64)",
  "commissionPercent": "integer (int32)",
  "configurationCity": "string",
  "configurationQuery": "string",
  "cpaCents": "integer (int32)",
  "dailyCapped": "integer (int32)",
  "dailyCappedTime": "string (date-time)",
  "dailyCapPublisherExclusion": "integer (int32)",
  "dailyCapResetTime": "string (date-time)",
  "defaultCpcCents": "integer (int32)",
  "displayName": "string",
  "emailAddress": "string",
  "excludeAffiliate": "string",
  "excludeAffiliateFeed": "string",
  "excludeHighQualityScoreAffiliate": "string",
  "exportSingleJob": "integer (int32)",
  "frJobsLoaded": "integer (int32)",
  "hostApplication": "integer (int32)",
  "hostApplicationRedirect": "integer (int32)",
  "isEnhanceBidding": "boolean",
  "jobsLoaded": "integer (int32)",
  "jobType": "integer (int32)",
  "lastUpdated": "string (date)",
  "mobileFriendly": "integer (int32)",
  "name": "string",
  "noQualityScoreAdjustmentAllowed": "integer (int32)",
  "optoutEmail": "integer (int32)",
  "pacingDom": "integer (int32)",
  "pending": "integer (int32)",
  "poolId": "integer (int64)",
  "prependTag": "string",
  "qqMultiplier": "number (float)",
  "registrationCpcCents": "integer (int32)",
  "requireResume": "integer (int32)",
  "resumeMatch": "number (float)",
  "spendCents": "integer (int32)",
  "spendThreshold": "integer (int32)",
  "status": "integer (int32)",
  "trackingTags": "string",
  "usOnly": "integer (int32)"
}

ResumegetResumeMatch200: object

Get Resume Match

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: ResumeMatchResult
title: string

Resume Match

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "jobStatus": "string",
    "matchProbabilityAngleComparison": "number (double)",
    "matchProbabilityHumanIntuitiveComparison": "number (double)",
    "status": "string"
  },
  "title": "string"
}

PutCompanyputCompanyColumns: object

columns

id: integer (int64)

Id

name: string

Name

Example
{
  "id": "integer (int64)",
  "name": "string"
}

GroupputGroupPause200: object

Pause Group Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: integer (int32)

Affected Rows

title: string

Pause Group

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "integer (int32)",
  "title": "string"
}

JobputJobPause200: object

Pause Job Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: PutJobputJobPauseResponseColumns
title: string

Pause Job

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

JobputJobResume200: object

Resume Job Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: PutJobputJobResumeResponseColumns
title: string

Resume Job

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

DeleteJobdeleteJobResponseColumns: object

columns

statusCode: string

Status Code

Example
{
  "statusCode": "string"
}

PutCampaignputCampaignBudgetDeltaResponseColumns: object

columns

statusCode: string

Status Code

Example
{
  "statusCode": "string"
}

JobgetJobStatus200: object

Get Job Status

documentationUrl: string

http://docs.odt.io/responses/200

metadata: MetaData
code: integer (int32)

200

data: GETJobgetJobStatusColumns

GETJobgetJobStatus

GETJobgetJobStatusColumns
title: string

Job Status

Example
{
  "documentationUrl": "string",
  "metadata": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "code": "integer (int32)",
  "data": [
    {
      "currentMonthSpendCents": "integer (int32)",
      "isMonthlyBudget": "boolean",
      "status": "string",
      "totalSpendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

Address: object

address: string

address

normalizedAddress: string

normalized address string

Example
{
  "address": "string",
  "normalizedAddress": "string"
}

GetJobCampaignColumns: object

columns

displayName: string

Campaign Display Name

emailAddress: string

Campaign Email Address

hostApplication: integer (int32)

Host Application Number

id: integer (int64)

Campaign Id

jobCustomerId: integer (int64)

Job Customer Id

name: string

Campaign Name

poolId: integer (int64)

Campaign Pool Id

spendCents: integer (int32)

Spending in cents

status: string

Status

Example
{
  "displayName": "string",
  "emailAddress": "string",
  "hostApplication": "integer (int32)",
  "id": "integer (int64)",
  "jobCustomerId": "integer (int64)",
  "name": "string",
  "poolId": "integer (int64)",
  "spendCents": "integer (int32)",
  "status": "string"
}

ResumeMatchResult: object

jobStatus: string

jobStatus

matchProbabilityAngleComparison: number (double)

matchProbabilityAngleComparison

matchProbabilityHumanIntuitiveComparison: number (double)

minorCategoryScore

status: string

status

Example
{
  "jobStatus": "string",
  "matchProbabilityAngleComparison": "number (double)",
  "matchProbabilityHumanIntuitiveComparison": "number (double)",
  "status": "string"
}

TosgetCustomerTosHasTos200: object

GET Customer ToS has ToS

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: boolean

has ToS

title: string

Customer Accepted ToS

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "boolean",
  "title": "string"
}

BillingpostBillingPaymentCardReceipt200: object

Payment Card Receipt

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: string

Payment Card Receipt

title: string

success

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": "string",
  "title": "string"
}

PutGroupputGroupStatusResponseColumns: object

columns

statusCode: string

Status Code

Example
{
  "statusCode": "string"
}

ResumegetResumeParse200: object

Get Resume Parse

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: ResumeDetails
title: string

Resume Parse

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "body": "string",
    "companyName": {
      "address": "string",
      "normalizedAddress": "string"
    },
    "emailAddress": "string (email)",
    "nationalIdentificationNumbers": [
      {
        "nationalIdentificationNumber": "string",
        "nationalIdentificationNumberSubtype": "string"
      }
    ],
    "personalName": "string",
    "phoneNumbers": [
      {
        "phoneNumber": "string",
        "phoneNumberSubtype": "string",
        "phoneNumberUse": "string"
      }
    ],
    "resourceName": "string",
    "uris": [
      {
        "normalizedURI": "string",
        "tags": [
          "string"
        ],
        "uri": "string"
      }
    ]
  },
  "title": "string"
}

GroupDataFilters: object

accountIds: string[]

account ID's

string
companyDetails: object[]

company details

object
companyIds: string[]

company ID's

string
includeFilterDetails: boolean

include filter details

industries: string[]

industries

string
jobDescriptions: string[]

job descriptions

string
jobStateIds: string[]

job state ID's

string
jobTitles: string[]

job titles

string
locations: string[]

locations

string
referenceNumbers: string[]

reference numbers

string
Example
{
  "accountIds": [
    "string"
  ],
  "companyDetails": [
    "object"
  ],
  "companyIds": [
    "string"
  ],
  "includeFilterDetails": "boolean",
  "industries": [
    "string"
  ],
  "jobDescriptions": [
    "string"
  ],
  "jobStateIds": [
    "string"
  ],
  "jobTitles": [
    "string"
  ],
  "locations": [
    "string"
  ],
  "referenceNumbers": [
    "string"
  ]
}

PutCampaignputCampaignBudgetResponseColumns: object

columns

statusCode: string

Status Code

Example
{
  "statusCode": "string"
}

GroupFilterSuggestionRequest: object

jobIds: string[]

job ID's

string
numberOfSuggestions: integer (int32)

number of suggestions

Example
{
  "jobIds": [
    "string"
  ],
  "numberOfSuggestions": "integer (int32)"
}

BillingpostBillingAddInvoice200: object

Add Invoice Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

title: string

Add Invoice

message: string

Success

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "title": "string",
  "message": "string"
}

JobIndustryClassificationModel: object

description: string

description

id: string

id

indication: string

indication

Example
{
  "description": "string",
  "id": "string",
  "indication": "string"
}

NationalIdentificationNumber: object

nationalIdentificationNumber: string

raw national identification number string

nationalIdentificationNumberSubtype: NationalIdentificationNumberSubtype
Example
{
  "nationalIdentificationNumber": "string",
  "nationalIdentificationNumberSubtype": "string"
}

DataValuePair: object

data: string
Example
{
  "data": "string"
}

PutJobputJobPauseResponseColumns: object

columns

statusCode: string

Status Code

Example
{
  "statusCode": "string"
}

PutJobputJobResumeResponseColumns: object

columns

statusCode: string

Status Code

Example
{
  "statusCode": "string"
}

PutJobputJobBudgetResponseColumns: object

columns

statusCode: string

Status Code

Example
{
  "statusCode": "string"
}

JobLocation: object

city: string

city

state: string

state

zipcode: string

zipcode

Example
{
  "city": "string",
  "state": "string",
  "zipcode": "string"
}

GETJobgetJobReportColumns: object

columns

applications: integer (int32)

Number of Applications

campaignId: integer (int64)

Campaign Id

clickDate: string (date)

Click Date. Format: YYYY-MM-DD

clicks: integer (int32)

Clicks

conversions1: integer (int32)

Conversions1

conversions2: integer (int32)

Conversions2

conversions3: integer (int32)

Conversions3

customerId: integer (int64)

Customer Id

groupId: integer (int64)

Group Id

impressions: integer (int32)

Impressions

jobId: integer (int64)

Job Id

poolId: integer (int64)

Pool Id

spendCents: integer (int32)

Spend in cents

Example
{
  "applications": "integer (int32)",
  "campaignId": "integer (int64)",
  "clickDate": "string (date)",
  "clicks": "integer (int32)",
  "conversions1": "integer (int32)",
  "conversions2": "integer (int32)",
  "conversions3": "integer (int32)",
  "customerId": "integer (int64)",
  "groupId": "integer (int64)",
  "impressions": "integer (int32)",
  "jobId": "integer (int64)",
  "poolId": "integer (int64)",
  "spendCents": "integer (int32)"
}

GETDashboardgetRemainingBudgetColumns: object

columns

remainingCents: integer (int32)

Remaining Budget in cents

Example
{
  "remainingCents": "integer (int32)"
}

PhoneNumberSubtype: string

string UNKNOWN, NORTH_AMERICAN_NUMBERING_PLAN

CustomerId: integer

Example
"integer (int64)"

PutJobputJobResponseColumns: object

columns

statusCode: string

Status Code

Example
{
  "statusCode": "string"
}

TextProcessingOptions: object

processPunctuation: boolean

whether to process punctuation

processStem: boolean

whether to process stem

processStopWords: boolean

whether to process stop words

processSynonyms: boolean

whether to process synonyms

Example
{
  "processPunctuation": "boolean",
  "processStem": "boolean",
  "processStopWords": "boolean",
  "processSynonyms": "boolean"
}

NationalIdentificationNumberSubtype: string

string UNKNOWN, SOCIAL_SECURITY_NUMBER

GETJobgetJobSummaryColumns: object

columns

applications: integer (int32)

Number of Applications

clicks: integer (int32)

Clicks

conversions1: integer (int32)

Conversions1

conversions2: integer (int32)

Conversions2

conversions3: integer (int32)

Conversions3

impressions: integer (int32)

Impressions

spendCents: integer (int32)

Spend in cents

Example
{
  "applications": "integer (int32)",
  "clicks": "integer (int32)",
  "conversions1": "integer (int32)",
  "conversions2": "integer (int32)",
  "conversions3": "integer (int32)",
  "impressions": "integer (int32)",
  "spendCents": "integer (int32)"
}

TosgetCustomerTosAcceptTos200: object

GET Customer Tos Accept ToS

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

title: string

Customer Accept ToS

message: string

Success

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "title": "string",
  "message": "string"
}

OldIndustrygetMapEitherIndustriesToOldJobIndustries200: object

Get Map Either Job Industry to Old Job Industries

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: string[]
string

Old Job Industry

title: string

Old Job Industries

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    "string"
  ],
  "title": "string"
}

CompanyputCompany200: object

Put Company

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: PUTCompanyputCompanyObject
title: string

Insert Company

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "details": {
      "id": "integer (int64)",
      "name": "string"
    },
    "statusCode": "string"
  },
  "title": "string"
}

GroupputGroupStatus200: object

Put Group Status

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: PutGroupputGroupStatusResponseColumns
title: string

Update Group Status

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": {
    "statusCode": "string"
  },
  "title": "string"
}

GETCustomergetCustomerReportColumns: object

columns

applications: integer (int32)

Number of Applications

clickDate: string (date)

Click Date. Format: YYYY-MM-DD

clicks: integer (int32)

Clicks

conversions1: integer (int32)

Conversions1

conversions2: integer (int32)

Conversions2

conversions3: integer (int32)

Conversions3

customerId: integer (int64)

Customer Id

impressions: integer (int32)

Impressions

spendCents: integer (int32)

Spending in cents

Example
{
  "applications": "integer (int32)",
  "clickDate": "string (date)",
  "clicks": "integer (int32)",
  "conversions1": "integer (int32)",
  "conversions2": "integer (int32)",
  "conversions3": "integer (int32)",
  "customerId": "integer (int64)",
  "impressions": "integer (int32)",
  "spendCents": "integer (int32)"
}

SourceId: integer

Example
"integer (int64)"

IndustrygetIndustryNGrams200: object

GET Industry N-Grams Response

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: NGram

Job Industry N-Grams

NGram
title: string

Industry N-Grams

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "value": "string",
      "weight": "number (double)"
    }
  ],
  "title": "string"
}

GETJobgetJobsColumns: object

columns

budgetCents: BudgetCents

budget in cents, in which -1 means unlimited budget

campaignId: integer (int64)

Campaign Id

cities: string[]

cities

string

cities

company: string

Company

companyId: integer (int64)

Company Id

cpcCents: integer (int32)

CPC in cents

created: string (date-time)

Created Date Time

customerId: integer (int64)

Customer Id

description: string

Job Description

email: string

Email Address

id: string

Job Id

jobReference: string

Job Reference Number

jobStatus: string

Job Status

majorCategories: TextPrediction
minorCategories: TextPrediction
poolId: integer (int64)

Pool Id

posted: string (date-time)

Posted Date Time

registrationCpcCents: integer (int32)

Registration Cpc in cents

groupId: integer (int64)

Group Id

stateIds: integer[]

State IDs

integer (int32)

State ID

status: string

Status

title: string

Title

url: string

URL

zipcodes: integer[]

Zipcodes

integer (int32)

Zipcode

Example
{
  "budgetCents": "integer (int32)",
  "campaignId": "integer (int64)",
  "cities": [
    "string"
  ],
  "company": "string",
  "companyId": "integer (int64)",
  "cpcCents": "integer (int32)",
  "created": "string (date-time)",
  "customerId": "integer (int64)",
  "description": "string",
  "email": "string",
  "id": "string",
  "jobReference": "string",
  "jobStatus": "string",
  "majorCategories": {
    "category": "string",
    "score": "number (double)"
  },
  "minorCategories": {
    "category": "string",
    "score": "number (double)"
  },
  "poolId": "integer (int64)",
  "posted": "string (date-time)",
  "registrationCpcCents": "integer (int32)",
  "groupId": "integer (int64)",
  "stateIds": [
    "integer (int32)"
  ],
  "status": "string",
  "title": "string",
  "url": "string",
  "zipcodes": [
    "integer (int32)"
  ]
}

QueryResult: object

metaData: MetaData
data: object[]
object
object
Example
{
  "metaData": {
    "columnDetails": [
      {
        "columnLabel": "string",
        "columnTypeName": "string"
      }
    ],
    "resultCount": "integer (int32)"
  },
  "data": [
    "object"
  ]
}

ResumeDetails: object

body: string

body

companyName: Address
emailAddress: string (email)

E-mail address

nationalIdentificationNumbers: NationalIdentificationNumber

national identification numbers

NationalIdentificationNumber
personalName: string

personal name

phoneNumbers: PhoneNumber

phone numbers

PhoneNumber
resourceName: string

resource name

uris: URIHolder

URIs

URIHolder
Example
{
  "body": "string",
  "companyName": {
    "address": "string",
    "normalizedAddress": "string"
  },
  "emailAddress": "string (email)",
  "nationalIdentificationNumbers": [
    {
      "nationalIdentificationNumber": "string",
      "nationalIdentificationNumberSubtype": "string"
    }
  ],
  "personalName": "string",
  "phoneNumbers": [
    {
      "phoneNumber": "string",
      "phoneNumberSubtype": "string",
      "phoneNumberUse": "string"
    }
  ],
  "resourceName": "string",
  "uris": [
    {
      "normalizedURI": "string",
      "tags": [
        "string"
      ],
      "uri": "string"
    }
  ]
}

JobgetJobs200: object

GET Job Details

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: GETJobgetJobsColumns

GETJobgetJobs

GETJobgetJobsColumns
title: string

Job Details

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "budgetCents": "integer (int32)",
      "campaignId": "integer (int64)",
      "cities": [
        "string"
      ],
      "company": "string",
      "companyId": "integer (int64)",
      "cpcCents": "integer (int32)",
      "created": "string (date-time)",
      "customerId": "integer (int64)",
      "description": "string",
      "email": "string",
      "id": "string",
      "jobReference": "string",
      "jobStatus": "string",
      "majorCategories": {
        "category": "string",
        "score": "number (double)"
      },
      "minorCategories": {
        "category": "string",
        "score": "number (double)"
      },
      "poolId": "integer (int64)",
      "posted": "string (date-time)",
      "registrationCpcCents": "integer (int32)",
      "groupId": "integer (int64)",
      "stateIds": [
        "integer (int32)"
      ],
      "status": "string",
      "title": "string",
      "url": "string",
      "zipcodes": [
        "integer (int32)"
      ]
    }
  ],
  "title": "string"
}

CustomergetCustomerReport200: object

Get Customer Report

documentationUrl: string

http://docs.odt.io/responses/200

code: integer (int32)

200

data: GETCustomergetCustomerReportColumns

GETCustomergetCustomerReport

GETCustomergetCustomerReportColumns
title: string

Customer Report

Example
{
  "documentationUrl": "string",
  "code": "integer (int32)",
  "data": [
    {
      "applications": "integer (int32)",
      "clickDate": "string (date)",
      "clicks": "integer (int32)",
      "conversions1": "integer (int32)",
      "conversions2": "integer (int32)",
      "conversions3": "integer (int32)",
      "customerId": "integer (int64)",
      "impressions": "integer (int32)",
      "spendCents": "integer (int32)"
    }
  ],
  "title": "string"
}

PutCampaignputCampaignStatusResponseColumns: object

columns

statusCode: string

Status Code

Example
{
  "statusCode": "string"
}

JobIndustryPredictionModel: object

majorCategory: string

majorCategory

majorCategoryScore: number (double)

majorCategoryScore

minorCategory: string

minorCategory

minorCategoryScore: number (double)

minorCategoryScore

Example
{
  "majorCategory": "string",
  "majorCategoryScore": "number (double)",
  "minorCategory": "string",
  "minorCategoryScore": "number (double)"
}

PredictionRequestParameters: object

company: string

company

desc: string

desc

locations: string[]

locations