PerformLine API Specification

Version 0.1.5

Overview

All assertions and specifications are subject to change.
All requests will be authenticated by passing an Authorization request header which authenticates the user and restricts access to only that user’s data.
Clients will need to contact Customer Success to obtain a token for their organization.
All endpoints are accessible exclusively over SSL on port 443.
All endpoints will emit JSON payloads (Content-Type application/json).
Data from these endpoints are updated every 60 minutes, while data in the UI may be fresher.
Requests for collections emit 100 records by default, but can be extended up to 500 records.
Pagination is handled by limit and offset query string parameters.
All API paths must end with a trailing forward slash (but before any query string (?) parameters). Requests that do not have a trailing slash will be permanently redirected (HTTP 301) to the correct endpoint.

Authentication

Authentication with the API is performed by including your API Token (issued by PerformLine) in all API requests using the Authorization header like so:

Authorization: Token XXXXXXXXXXXXXXXXXXX

Response Objects

The API responds to all requests with a standardized response structure that resembles the following:

For endpoints that return multiple results (e.g.: queries), the Results key will be an array of objects. For endpoints returning individual items, the key will contain an object.

Errors

The PerformLine API uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, the requested resource is missing, etc.), and codes in the 5xx range indicate an error with PerformMatch API servers. A typical error response will be a JSON object that resembles the following:

Endpoints

Below is the documentation for all supported API endpoints in the PerformLine Customer API.

GET /scoring/v1/overrides/:id/

GET /scoring/v1/content-tags/:entity_id/

GET /metrics/

GET /document/cases/:id/audit

GET /api/v1/document/cases/:id/audit

GET /common/brands/ Returns a list of all brands matching the given criteria.

Query String Parameters

Parameter	Description	Example
`limit`	Limits the number of results per request.	`?limit=50`
`offset`	Offsets the results by the given number of records.	`&offset=25`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this brand.
Integer
Name
The brand's name.
String

GET /common/brands/:id/ Retrieves details on a specific brand.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this brand.
Integer
Name
The brand's name.
String

GET /common/brands/:brand_id/rules/ Returns a list of all rules from the specified brand and by additional query parameters.

Query String Parameters

Parameter	Description	Example
`rule_type`	Filters the results by rule type: banned, required, conditionalBanned, conditionalRequired, spotlight	`?rule_type=conditionalBanned`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this rule.
Integer
Name
The Rule's name.
String
Weight
The weight of the Rule.
String

GET /common/campaigns/ Returns a list of all campaigns.

Query String Parameters

Parameter	Description	Example
`brand`	Restrict results to the given Brand ID(s).	`?brand=11,13`
`limit`	Limits the number of results per request.	`&limit=50`
`offset`	Offsets the results by the given number of records.	`&offset=25`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this campaign.
Integer
Name
The name of the campaign.
String
Description
A description of the campaign.
String
BrandId
The Brand this campaign belongs to.
Integer
CompanyId
The Company this campaign belongs to.
Integer

GET /common/campaigns/:id/ Retrieves details on a specific campaign.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this campaign.
Integer
Name
The name of the campaign.
String
Description
A description of the campaign.
String
BrandId
The Brand this campaign belongs to.
Integer
CompanyId
The Company this campaign belongs to.
Integer

GET /common/campaigns/:campaign_id/rules/ Returns a list of all rules from the specified campaign and by additional query parameters.

Query String Parameters

Parameter	Description	Example
`rule_type`	Filters the results by rule type: banned, required, conditionalBanned, conditionalRequired, spotlight	`?rule_type=conditionalBanned`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this rule.
Integer
Name
The Rule's name.
String
Weight
The weight of the Rule.
String

GET /common/rules/ Returns a list of all rules filtered by your API token and by additional query parameters.

Query String Parameters

Parameter	Description	Example
`rule_type`	Filters the results by rule type: banned, required, conditionalBanned, conditionalRequired, spotlight	`?rule_type=conditionalBanned`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this rule.
Integer
Name
The Rule's name.
String
Weight
The weight of the Rule.
String

GET /common/trafficsources/ Returns a list of all traffic sources.

Query String Parameters

Parameter	Description	Example
`limit`	Limits the number of results per request.	`?limit=50`
`offset`	Offsets the results by the given number of records.	`&offset=25`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this traffic source.
Integer
Name
The name of the traffic source.
String
CompanyId
The Company this traffic source belongs to.
Integer

GET /common/trafficsources/:id/ Retrieves details on a specific traffic source.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this traffic source.
Integer
Name
The name of the traffic source.
String
CompanyId
The Company this traffic source belongs to.
Integer

GET /common/remediation_status/ Retrieves all available remediation statuses.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Statuses
List of remediation statuses.
Other

POST /request-upload/ Request S3 pre-signed upload url.

Request Parameters

Parameter	Description	Example
`campaign_id`	Campaign Id for upload.	`1193`
`uploader_email`	Uploader email.	`bob@performline.com`
`internal_id`	Your internal Id used to identify uploaded entity.	`B4ZF9CMHB5NYCA`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

EntityId String
Title String

POST /upload/ Upload data to PerformLine for further processing.

Request Parameters

Parameter	Description	Example
`campaign_id`	Campaign Id for upload.	`1193`
`uploader_email`	Uploader email.	`bob@performline.com`
`internal_id`	Your internal Id used to identify uploaded entity.	`B4ZF9CMHB5NYCA`
`file_data`	File binary data.	`{binary data}`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

EntityId String
Title String

GET /common/items/ Retrieves a list of scorable items across all PerformLine product offerings.

Query String Parameters

Parameter	Description	Example
`brand`	Restrict results to the given Brand ID(s).	`?brand=11,13`
`campaign`	Restrict results to the given Campaign ID(s).	`&campaign=3`
`created_to`	Restrict results to pages created till created_to date.	`&created_to=2018-01-31 or 30 days`
`created_from`	Restrict results to pages created after created_from date.	`&created_from=2018-01-01 or 60 days`
`scored_to`	Restrict results to pages scored till scored_to date.	`&scored_to=2018-01-31 or 30 days`
`scored_from`	Restrict results to pages scored after scored_from date.	`&scored_from=2018-01-01 or 60 days`
`max_score`	Restrict results to score less than max_score	`&max_score=80`
`min_score`	Restrict results to score greater than min_score	`&min_score=30`
`remediation_status`	Restrict results to the given Remediation Status(es).	`&remediation_status=In Progress`
`limit`	Limits the number of results per request.	`&limit=50`
`offset`	Offsets the results by the given number of records.	`&offset=25`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
Integer
Type
The product type this item belongs to.
String
Score
The score (out of 100) of the item.
Integer
TrafficSourceId
The Traffic Source the item belongs to.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
CompanyId
The Company the item belongs to.
Integer
CreatedAt
The time the item was first created in the system.
Time
Url
The URL of the item being monitored (if applicable).
String
LastScoredAt
The date/time the item was last scored.
Time
RemediationStatus
The current remediation status.
String
Tags
List of tags associated with this object.
Other
Agent
The call center rep id/agent (if applicable).
String
CallLength
The call length (if applicable).
String

GET /common/items/:id/ Retrieves details on a specific scorable content item.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
Integer
Type
The product type this item belongs to.
String
Score
The score (out of 100) of the item.
Integer
TrafficSourceId
The Traffic Source the item belongs to.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
CompanyId
The Company the item belongs to.
Integer
CreatedAt
The time the item was first created in the system.
Time
Url
The URL of the item being monitored (if applicable).
String
LastScoredAt
The date/time the item was last scored.
Time
RemediationStatus
The current remediation status.
String
Tags
List of tags associated with this object.
Other
Agent
The call center rep id/agent (if applicable).
String
CallLength
The call length (if applicable).
String

GET /common/items/:id/workflow/ Retrieves details on a specific item's workflows.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for the requested Page.
Integer
Status
Status of workflow.
String
Owner
Owner of workflow.
String
DueDate
Date workflow should be completed.
Time
Note
Note for workflow
String
User
User who created this workflow
String
Created
Date/time that this workflow was created
Time

GET /web/pages/ Retrieves a list of web pages that PerformLine scans and scores.

Query String Parameters

Parameter	Description	Example
`brand`	Restrict results to the given Brand ID(s).	`?brand=11,13`
`campaign`	Restrict results to the given Campaign ID(s).	`&campaign=3`
`created_to`	Restrict results to pages created till created_to date.	`&created_to=2018-01-31 or 30 days`
`created_from`	Restrict results to pages created after created_from date.	`&created_from=2018-01-01 or 60 days`
`scored_to`	Restrict results to pages scored till scored_to date.	`&scored_to=2018-01-31 or 30 days`
`scored_from`	Restrict results to pages scored after scored_from date.	`&scored_from=2018-01-01 or 60 days`
`max_score`	Restrict results to score less than max_score	`&max_score=80`
`min_score`	Restrict results to score greater than min_score	`&min_score=30`
`remediation_status`	Restrict results to the given Remediation Status(es).	`&remediation_status=In Progress`
`limit`	Limits the number of results per request.	`&limit=50`
`offset`	Offsets the results by the given number of records.	`&offset=25`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
Integer
Type
The product type this item belongs to.
String
Score
The score (out of 100) of the item.
Integer
TrafficSourceId
The Traffic Source the item belongs to.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
CompanyId
The Company the item belongs to.
Integer
CreatedAt
The time the item was first created in the system.
Time
Url
The URL of the item being monitored (if applicable).
String
LastScoredAt
The date/time the item was last scored.
Time
RemediationStatus
The current remediation status.
String
Tags
List of tags associated with this object.
Other
Agent
The call center rep id/agent (if applicable).
String
CallLength
The call length (if applicable).
String

GET /web/pages/:id/ Retrieves details on a specific web page.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
Integer
Type
The product type this item belongs to.
String
Score
The score (out of 100) of the item.
Integer
TrafficSourceId
The Traffic Source the item belongs to.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
CompanyId
The Company the item belongs to.
Integer
CreatedAt
The time the item was first created in the system.
Time
Url
The URL of the item being monitored (if applicable).
String
LastScoredAt
The date/time the item was last scored.
Time
RemediationStatus
The current remediation status.
String
Tags
List of tags associated with this object.
Other
Agent
The call center rep id/agent (if applicable).
String
CallLength
The call length (if applicable).
String

GET /document/documents/ Retrieves all available documents.

Query String Parameters

Parameter	Description	Example
`brand`	Restrict results to the given Brand ID(s).	`?brand=1187,1378`
`campaign`	Restrict results to the given Campaign ID(s).	`&campaign=1733`
`created_to`	Restrict results to documents created till created_to date.	`&created_to=2018-01-31 or 30 days`
`created_from`	Restrict results to documents created after created_from date.	`&created_from=2018-01-01 or 60 days`
`scored_to`	Restrict results to documents scored till scored_to date.	`&scored_to=2018-01-31 or 30 days`
`scored_from`	Restrict results to documents scored after scored_from date.	`&scored_from=2018-01-01 or 60 days`
`max_score`	Restrict results to score less than max_score	`&max_score=80`
`min_score`	Restrict results to score greater than min_score	`&min_score=30`
`limit`	Limits the number of results per request.	`&limit=50`
`offset`	Offsets the results by the given number of records.	`&offset=25`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
String
Title
Document title.
String
Score
Document score.
Integer

GET /document/documents/:id/ Retrieves document by Id.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
String
Title
Document title.
String
Pages
Number of pages.
Integer
Score
The score (out of 100) of the item.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
DocumentType
Document mime type: pdf, docx, jpg.
String
Submitter
Uploader username.
String
UploadDate
Upload date.
Time
CasesIds
List of cases associated with this document.
Other
LastScoredAt
The date/time the item was last scored.
Time
IngestionMethod
email or user
String

GET /document/documents/:id/violations/ Retrieves violation details on a specific document.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

ID
Document entity ID.
String
TermID
ID of the Term within this violation.
Integer
TermType
Term type.
String
TermName
The Term's name.
String
RuleID
ID of Rule that the term is in.
Integer
RuleName
Name of Rule.
String
RuleType
Type of Rule (Required, Banned, etc).
String
Occurrences
Number of occurrences.
Integer
Datetime
Datetime that this violation occurred.
Time
Deduction
If enabled within brand, the amount of points this violation deducted.
Float
WordIndex
Number of occurrences.
Integer

GET /document/cases/ Retrieves all available cases.

Query String Parameters

Parameter	Description	Example
`brand`	Restrict results to the given Brand ID(s).	`?brand=1187,1378`
`campaign`	Restrict results to the given Campaign ID(s).	`&campaign=1733`
`created_to`	Restrict results to cases created till created_to date.	`&created_to=2018-01-31 or 30 days`
`created_from`	Restrict results to cases created after created_from date.	`&created_from=2018-01-01 or 60 days`
`state`	Restrict results to cases in specific state.	`&state=Opened`
`expired`	Restrict results to expired or unexpired cases.	`&expired=true`
`owner`	Restrict results to owner of the case.	`&owner=bob@performline.com`
`limit`	Limits the number of results per request.	`&limit=50`
`offset`	Offsets the results by the given number of records.	`&offset=25`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
String
Title
Case title.
String

GET /document/cases/:id/ Retrieves case by Id.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
String
CaseNumber
Case Number.
String
BrandID String
Title
Case title.
String
Description
Case Description.
String
Queue
Case Queue.
String
State
Case State.
String
Owner
Case Owner.
String
Comments Other
DocumentIds Other
UpdatedAt
Case update date/time.
Time
CreatedAt
Case create date/time.
Time
Labels Other

GET /web/pages/:id/workflow/ Retrieves details on a specific web page's workflows.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for the requested Page.
Integer
Status
Status of workflow.
String
Owner
Owner of workflow.
String
DueDate
Date workflow should be completed.
Time
Note
Note for workflow
String
User
User who created this workflow
String
Created
Date/time that this workflow was created
Time

GET /web/pages/:id/content/ Retrieves specific web page's source code.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

ID
Unique identifier for the requested Page.
Integer
ScorableContent
The raw content that gets scored.
String

GET /web/pages/:page_id/violations/ Retrieves violation details on a specific page.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

ID
Unique identifier for this violation.
Integer
TermID
ID of the Term within this violation.
Integer
TermName
The Term's name.
String
RuleID
ID of Rule that the term is in.
Integer
RuleName
Name of Rule.
String
RuleType
Type of Rule (Required, Banned, etc).
String
PageID
ID of the page associated with this violation.
Integer
PageType
Type of page associated with this violation.
String
Occurrences
Number of occurrences.
Integer
Datetime
Datetime that this violation occurred.
Time
Deduction
If enabled within brand, the amount of points this violation deducted.
Integer
Participant
If rule is set up for stereo calls, can be Agent or Caller.
String
timestamps
Timestamps for occurrences of this violation, in seconds (Call center only).
Other
- Boolean
- Other

GET /callcenter/calls/ Retrieves a list of transcribed and scored calls within PerformLine's Call Center product.

Query String Parameters

Parameter	Description	Example
`brand`	Restrict results to the given Brand ID(s).	`?brand=11,13`
`campaign`	Restrict results to the given Campaign ID(s).	`&campaign=3`
`created_to`	Restrict results to pages created till created_to date.	`&created_to=2018-01-31 or 30 days`
`created_from`	Restrict results to pages created after created_from date.	`&created_from=2018-01-01 or 60 days`
`scored_to`	Restrict results to pages scored till scored_to date.	`&scored_to=2018-01-31 or 30 days`
`scored_from`	Restrict results to pages scored after scored_from date.	`&scored_from=2018-01-01 or 60 days`
`max_score`	Restrict results to score less than max_score	`&max_score=80`
`min_score`	Restrict results to score greater than min_score	`&min_score=30`
`remediation_status`	Restrict results to the given Remediation Status(es).	`&remediation_status=In Progress`
`limit`	Limits the number of results per request.	`&limit=50`
`offset`	Offsets the results by the given number of records.	`&offset=25`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
Integer
Type
The product type this item belongs to.
String
Score
The score (out of 100) of the item.
Integer
TrafficSourceId
The Traffic Source the item belongs to.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
CompanyId
The Company the item belongs to.
Integer
CreatedAt
The time the item was first created in the system.
Time
LastScoredAt
The date/time the item was last scored.
Time
RemediationStatus
The current remediation status.
String
Tags
List of tags associated with this object.
Other
Agent
The call center rep id/agent (if applicable).
String
CallLength
The call length (if applicable).
String
CallId
The original call ID.
String
InquiryId
The ID of the inquiry.
String
RecordedOn
The date/time that the call was recorded.
String
FileLocation
Original call file location.
String

GET /callcenter/calls/:id/ Retrieves details on a specific transcribed and scored call.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
Integer
Type
The product type this item belongs to.
String
Score
The score (out of 100) of the item.
Integer
TrafficSourceId
The Traffic Source the item belongs to.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
CompanyId
The Company the item belongs to.
Integer
CreatedAt
The time the item was first created in the system.
Time
LastScoredAt
The date/time the item was last scored.
Time
RemediationStatus
The current remediation status.
String
Tags
List of tags associated with this object.
Other
Agent
The call center rep id/agent (if applicable).
String
CallLength
The call length (if applicable).
String
CallId
The original call ID.
String
InquiryId
The ID of the inquiry.
String
RecordedOn
The date/time that the call was recorded.
String
FileLocation
Original call file location.
String

GET /callcenter/calls/:id/workflow/ Retrieves details on a specific call's workflows.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for the requested Page.
Integer
Status
Status of workflow.
String
Owner
Owner of workflow.
String
DueDate
Date workflow should be completed.
Time
Note
Note for workflow
String
User
User who created this workflow
String
Created
Date/time that this workflow was created
Time

GET /callcenter/calls/:id/content/ Retrieves specific call's source code.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

ID
Unique identifier for the requested Page.
Integer
ScorableContent
The raw content that gets scored.
String

GET /callcenter/calls/:page_id/violations/ Retrieves violation details on a specific call.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

ID
Unique identifier for this violation.
Integer
TermID
ID of the Term within this violation.
Integer
TermName
The Term's name.
String
RuleID
ID of Rule that the term is in.
Integer
RuleName
Name of Rule.
String
RuleType
Type of Rule (Required, Banned, etc).
String
PageID
ID of the page associated with this violation.
Integer
PageType
Type of page associated with this violation.
String
Occurrences
Number of occurrences.
Integer
Datetime
Datetime that this violation occurred.
Time
Deduction
If enabled within brand, the amount of points this violation deducted.
Integer
Participant
If rule is set up for stereo calls, can be Agent or Caller.
String
timestamps
Timestamps for occurrences of this violation, in seconds (Call center only).
Other
- Boolean
- Other

GET /chatscout/chats/ Retrieves a list of scored chat transcript items within PerformLine's ChatScout product.

Query String Parameters

Parameter	Description	Example
`brand`	Restrict results to the given Brand ID(s).	`?brand=11,13`
`campaign`	Restrict results to the given Campaign ID(s).	`&campaign=3`
`created_to`	Restrict results to pages created till created_to date.	`&created_to=2018-01-31 or 30 days`
`created_from`	Restrict results to pages created after created_from date.	`&created_from=2018-01-01 or 60 days`
`scored_to`	Restrict results to pages scored till scored_to date.	`&scored_to=2018-01-31 or 30 days`
`scored_from`	Restrict results to pages scored after scored_from date.	`&scored_from=2018-01-01 or 60 days`
`max_score`	Restrict results to score less than max_score	`&max_score=80`
`min_score`	Restrict results to score greater than min_score	`&min_score=30`
`remediation_status`	Restrict results to the given Remediation Status(es).	`&remediation_status=In Progress`
`limit`	Limits the number of results per request.	`&limit=50`
`offset`	Offsets the results by the given number of records.	`&offset=25`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
Integer
SessionId
The chat session ID.
String
Type
The product type this item belongs to.
String
Score
The score (out of 100) of the item.
Integer
TrafficSourceId
The Traffic Source the item belongs to.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
CompanyId
The Company the item belongs to.
Integer
CreatedAt
The time the item was first created in the system.
Time
Url
The URL of the item being monitored (if applicable).
String
LastScoredAt
The date/time the item was last scored.
Time
RemediationStatus
The current remediation status.
String
Tags
List of tags associated with this object.
Other
Agent
The chat agent (if applicable).
String
Visitor
The chat visitor (if applicable).
String
Duration
The chat duration (if applicable).
String
WordCount
The chat word count (if applicable).
String

GET /chatscout/chats/:id/ Retrieves details on a specific chat transcript item.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
Integer
SessionId
The chat session ID.
String
Type
The product type this item belongs to.
String
Score
The score (out of 100) of the item.
Integer
TrafficSourceId
The Traffic Source the item belongs to.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
CompanyId
The Company the item belongs to.
Integer
CreatedAt
The time the item was first created in the system.
Time
Url
The URL of the item being monitored (if applicable).
String
LastScoredAt
The date/time the item was last scored.
Time
RemediationStatus
The current remediation status.
String
Tags
List of tags associated with this object.
Other
Agent
The chat agent (if applicable).
String
Visitor
The chat visitor (if applicable).
String
Duration
The chat duration (if applicable).
String
WordCount
The chat word count (if applicable).
String

GET /chatscout/chats/:id/workflow/ Retrieves details on a specific chat's workflows.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for the requested Page.
Integer
Status
Status of workflow.
String
Owner
Owner of workflow.
String
DueDate
Date workflow should be completed.
Time
Note
Note for workflow
String
User
User who created this workflow
String
Created
Date/time that this workflow was created
Time

GET /chatscout/chats/:id/content/ Retrieves specific chat's source code.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

ID
Unique identifier for the requested Page.
Integer
ScorableContent
The raw content that gets scored.
String

GET /chatscout/chats/:page_id/violations/ Retrieves violation details on a specific chat.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

ID
Unique identifier for this violation.
Integer
TermID
ID of the Term within this violation.
Integer
TermName
The Term's name.
String
RuleID
ID of Rule that the term is in.
Integer
RuleName
Name of Rule.
String
RuleType
Type of Rule (Required, Banned, etc).
String
PageID
ID of the page associated with this violation.
Integer
PageType
Type of page associated with this violation.
String
Occurrences
Number of occurrences.
Integer
Datetime
Datetime that this violation occurred.
Time
Deduction
If enabled within brand, the amount of points this violation deducted.
Integer
Participant
If rule is set up for stereo calls, can be Agent or Caller.
String
timestamps
Timestamps for occurrences of this violation, in seconds (Call center only).
Other
- Boolean
- Other

GET /email/messages/ Retrieves a list of scored email messages received by PerformLine's Email product.

Query String Parameters

Parameter	Description	Example
`brand`	Restrict results to the given Brand ID(s).	`?brand=11,13`
`campaign`	Restrict results to the given Campaign ID(s).	`&campaign=3`
`created_to`	Restrict results to pages created till created_to date.	`&created_to=2018-01-31 or 30 days`
`created_from`	Restrict results to pages created after created_from date.	`&created_from=2018-01-01 or 60 days`
`scored_to`	Restrict results to pages scored till scored_to date.	`&scored_to=2018-01-31 or 30 days`
`scored_from`	Restrict results to pages scored after scored_from date.	`&scored_from=2018-01-01 or 60 days`
`max_score`	Restrict results to score less than max_score	`&max_score=80`
`min_score`	Restrict results to score greater than min_score	`&min_score=30`
`remediation_status`	Restrict results to the given Remediation Status(es).	`&remediation_status=In Progress`
`limit`	Limits the number of results per request.	`&limit=50`
`offset`	Offsets the results by the given number of records.	`&offset=25`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
Integer
Type
The product type this item belongs to.
String
Score
The score (out of 100) of the item.
Integer
TrafficSourceId
The Traffic Source the item belongs to.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
CompanyId
The Company the item belongs to.
Integer
CreatedAt
The time the item was first created in the system.
Time
Url
The URL of the item being monitored (if applicable).
String
LastScoredAt
The date/time the item was last scored.
Time
RemediationStatus
The current remediation status.
String
Tags
List of tags associated with this object.
Other
EmailSender
The email sender (if applicable).
String
EmailRecipient
The email recipient (if applicable).
String

GET /email/messages/:id/ Retrieves details on a specific email message.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
Integer
Type
The product type this item belongs to.
String
Score
The score (out of 100) of the item.
Integer
TrafficSourceId
The Traffic Source the item belongs to.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
CompanyId
The Company the item belongs to.
Integer
CreatedAt
The time the item was first created in the system.
Time
Url
The URL of the item being monitored (if applicable).
String
LastScoredAt
The date/time the item was last scored.
Time
RemediationStatus
The current remediation status.
String
Tags
List of tags associated with this object.
Other
EmailSender
The email sender (if applicable).
String
EmailRecipient
The email recipient (if applicable).
String

GET /email/messages/:id/workflow/ Retrieves details on a specific email message's workflows.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for the requested Page.
Integer
Status
Status of workflow.
String
Owner
Owner of workflow.
String
DueDate
Date workflow should be completed.
Time
Note
Note for workflow
String
User
User who created this workflow
String
Created
Date/time that this workflow was created
Time

GET /email/messages/:id/content/ Retrieves specific message's source code.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

ID
Unique identifier for the requested Page.
Integer
ScorableContent
The raw content that gets scored.
String

GET /email/messages/:page_id/violations/ Retrieves violation details on a specific email.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

ID
Unique identifier for this violation.
Integer
TermID
ID of the Term within this violation.
Integer
TermName
The Term's name.
String
RuleID
ID of Rule that the term is in.
Integer
RuleName
Name of Rule.
String
RuleType
Type of Rule (Required, Banned, etc).
String
PageID
ID of the page associated with this violation.
Integer
PageType
Type of page associated with this violation.
String
Occurrences
Number of occurrences.
Integer
Datetime
Datetime that this violation occurred.
Time
Deduction
If enabled within brand, the amount of points this violation deducted.
Integer
Participant
If rule is set up for stereo calls, can be Agent or Caller.
String
timestamps
Timestamps for occurrences of this violation, in seconds (Call center only).
Other
- Boolean
- Other

GET /social/posts/ Retrieves a list of social posts that PerformLine scans and scores.

Query String Parameters

Parameter	Description	Example
`brand`	Restrict results to the given Brand ID(s).	`?brand=11,13`
`campaign`	Restrict results to the given Campaign ID(s).	`&campaign=3`
`created_to`	Restrict results to pages created till created_to date.	`&created_to=2018-01-31 or 30 days`
`created_from`	Restrict results to pages created after created_from date.	`&created_from=2018-01-01 or 60 days`
`scored_to`	Restrict results to pages scored till scored_to date.	`&scored_to=2018-01-31 or 30 days`
`scored_from`	Restrict results to pages scored after scored_from date.	`&scored_from=2018-01-01 or 60 days`
`max_score`	Restrict results to score less than max_score	`&max_score=80`
`min_score`	Restrict results to score greater than min_score	`&min_score=30`
`remediation_status`	Restrict results to the given Remediation Status(es).	`&remediation_status=In Progress`
`limit`	Limits the number of results per request.	`&limit=50`
`offset`	Offsets the results by the given number of records.	`&offset=25`

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
Integer
Type
The product type this item belongs to.
String
Score
The score (out of 100) of the item.
Integer
TrafficSourceId
The Traffic Source the item belongs to.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
CompanyId
The Company the item belongs to.
Integer
CreatedAt
The time the item was first created in the system.
Time
Url
The URL of the item being monitored (if applicable).
String
LastScoredAt
The date/time the item was last scored.
Time
RemediationStatus
The current remediation status.
String
Tags
List of tags associated with this object.
Other
Agent
The call center rep id/agent (if applicable).
String
CallLength
The call length (if applicable).
String

GET /social/posts/:id/ Retrieves details on a specific social post.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for this item.
Integer
Type
The product type this item belongs to.
String
Score
The score (out of 100) of the item.
Integer
TrafficSourceId
The Traffic Source the item belongs to.
Integer
CampaignId
The Campaign the item belongs to.
Integer
BrandId
The Brand the item belongs to.
Integer
CompanyId
The Company the item belongs to.
Integer
CreatedAt
The time the item was first created in the system.
Time
Url
The URL of the item being monitored (if applicable).
String
LastScoredAt
The date/time the item was last scored.
Time
RemediationStatus
The current remediation status.
String
Tags
List of tags associated with this object.
Other
Agent
The call center rep id/agent (if applicable).
String
CallLength
The call length (if applicable).
String

GET /social/posts/:id/workflow/ Retrieves details on a specific social post's workflows.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

Id
Unique identifier for the requested Page.
Integer
Status
Status of workflow.
String
Owner
Owner of workflow.
String
DueDate
Date workflow should be completed.
Time
Note
Note for workflow
String
User
User who created this workflow
String
Created
Date/time that this workflow was created
Time

GET /social/posts/:id/content/ Retrieves specific social post's source code.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

ID
Unique identifier for the requested Page.
Integer
ScorableContent
The raw content that gets scored.
String

GET /social/posts/:page_id/violations/ Retrieves violation details on a specific post.

Responses

HTTP 200 (Content-Type: application/json)

Example Output

Attributes

ID
Unique identifier for this violation.
Integer
TermID
ID of the Term within this violation.
Integer
TermName
The Term's name.
String
RuleID
ID of Rule that the term is in.
Integer
RuleName
Name of Rule.
String
RuleType
Type of Rule (Required, Banned, etc).
String
PageID
ID of the page associated with this violation.
Integer
PageType
Type of page associated with this violation.
String
Occurrences
Number of occurrences.
Integer
Datetime
Datetime that this violation occurred.
Time
Deduction
If enabled within brand, the amount of points this violation deducted.
Integer
Participant
If rule is set up for stereo calls, can be Agent or Caller.
String
timestamps
Timestamps for occurrences of this violation, in seconds (Call center only).
Other
- Boolean
- Other