PerformLine

PerformLine API Specification

Version 0.1.5

Overview

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:

{
  • Status: "success",
  • StatusCode: 200,
  • Results: [
    1. {
      • Id: 100,
      • Name: "Foo Bar"
      }
    ]
}

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: 

{
  • Status: "error",
  • StatusCode: 400,
  • ErrorMessage: "Bad Request",
  • ErrorDetail: "You have specified an unsupported or malformed parameter."
}

Endpoints

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

GET /scoring/v1/overrides/:id/ Retrieves override details for a specific asset.

Responses

HTTP 200 (Content-Type: application/json)

Example Output
{
  • Status: "success",
  • StatusCode: 200,
  • ServiceName: "scoring-service",
  • Results: {
    • id: "24717737",
    • overrides: "this term is not allowed", "banned", "example"
    }
}
Attributes
  • id

    ID of the asset.

     String
  • overrides

    All of the violations that are overridden on a page.

     Nullable

GET /scoring/v1/content-tags/:entity_id/ Retrieves content tags for a specific entity.

Responses

HTTP 200 (Content-Type: application/json)

Example Output
{
  • status: "success",
  • message: "Tags retrieved successfully",
  • results: {
    • content: "This is the scorable content.",
    • tags: [
        • word_index: 0,
        • start_index: 0,
        • end_index: 4,
        • term: "example_term",
        • rule_id: 123,
        • rule_name: "example_rule",
        • rule_type: "banned",
        • term_id: 456,
        • is_trigger: true
      ]
    }
}
Attributes
  • content

    The scorable content.

     String
  • tags

    List of tags applied to the content.

     List
  • word_index

    The index of the term in the content.

     Integer
  • start_index

    Start index of the term in the content.

     Integer
  • end_index

    End index of the term in the content.

     Integer
  • term

    The term that is overridden.

     String
  • rule_id

    ID of the rule associated with the term.

     Integer
  • rule_name

    Name of the rule associated with the term.

     String
  • rule_type

    Type of rule (e.g., banned, required).

     String
  • term_id

    ID of the term.

     Integer
  • is_trigger

    Indicates whether the term is a trigger for the rule.

     Boolean

GET /api/v1/document/cases/:id/audit Retrieves the audit details for a specific case.

Responses

HTTP 200 (Content-Type: application/json)

Example Output
{
  • Results: [
      • id: "147ee8ee-4f00-4682-9521-744efa15504a",
      • title: "Case X",
      • case_number: "C12345",
      • created_at: "2023-08-07T12:34:56Z",
      • transition_by: "user@example.com",
      • from_state: "new",
      • to_state: "open",
      • document_ids: "PLUE6BGJ4FXRF63K4HANRNR2RCF4,PLPU3QCIWOJBBQJAFWQAHHGN5NSI",
      • case_creator: "creator@example.com",
      • case_assignee: "assignee@example.com"
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
Attributes
  • id

    Unique identifier for this audit entry.

     String
  • title

    Title of the case.

     String
  • case_number

    Case number.

     String
  • created_at

    Timestamp of when the audit entry was created.

     DateTime
  • transition_by

    Email of the user who made the transition.

     String
  • from_state

    Initial state of the case.

     String
  • to_state

    Final state of the case.

     String
  • document_ids

    Comma-separated list of document IDs related to this case.

     String
  • case_creator

    Email of the case creator.

     String
  • case_assignee

    Email of the case assignee.

     String

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
{
  • Results: [
    1. {
      • Id: 11,
      • Name: "A. Foo Industries"
      },
    2. {
      • Id: 12,
      • Name: "BAR, Inc."
      },
    3. {
      • Id: 13,
      • Name: "Baz Media"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • Id: 11,
    • Name: "A. Foo Industries"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Id: 91,
      • Name: "Cannot say these",
      • Weight: "high"
      },
    2. {
      • Id: 112,
      • Name: "Must say these",
      • Weight: "low"
      },
    3. {
      • Id: 134,
      • Name: "Sometimes you much say these",
      • Weight: "medium"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • BrandId: 11,
      • CompanyId: 10,
      • Description: "",
      • Id: 1,
      • Name: "A. Foo: Content"
      },
    2. {
      • BrandId: 12,
      • CompanyId: 10,
      • Description: "",
      • Id: 2,
      • Name: "A. Foo: Disclosure Page"
      },
    3. {
      • BrandId: 13,
      • CompanyId: 10,
      • Description: "",
      • Id: 3,
      • Name: "BAR, Inc.: Content"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • BrandId: 11,
    • CompanyId: 10,
    • Description: "A. Foo is a campaign to catch compliance violations.",
    • Id: 1,
    • Name: "A. Foo: Content"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Id: 91,
      • Name: "Cannot say these",
      • Weight: "high"
      },
    2. {
      • Id: 112,
      • Name: "Must say these",
      • Weight: "medium"
      },
    3. {
      • Id: 134,
      • Name: "Sometimes you much say these",
      • Weight: "low"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Id: 91,
      • Name: "Cannot say these",
      • Weight: "low"
      },
    2. {
      • Id: 112,
      • Name: "Must say these",
      • Weight: "medium"
      },
    3. {
      • Id: 134,
      • Name: "Sometimes you much say these",
      • Weight: "high"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • CompanyId: 10,
      • Id: 1,
      • Name: "tester"
      },
    2. {
      • CompanyId: 10,
      • Id: 2,
      • Name: "managed-tester"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • CompanyId: 10,
    • Id: 1,
    • Name: "tester"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • Statuses: [
      1. "Not reviewed",
      2. "Opened",
      3. "In progress",
      4. "Escalated",
      5. "Closed no action required",
      6. "Closed resolved"
      ]
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • EntityId: "PLSAG2BBHBZFCMHB5NYCV2QPR4YM",
      • Title: "important_document.pdf"
      },
    2. {
      • EntityId: "PLCCSEGCMNGFF63EV6EMJUMXXMGM",
      • Title: "legal.docx"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • EntityId: "PLSAG2BBHBZFCMHB5NYCV2QPR4YM",
      • Title: "important_document.pdf"
      },
    2. {
      • EntityId: "PLCCSEGCMNGFF63EV6EMJUMXXMGM",
      • Title: "legal.docx"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • BrandId: 11,
      • CampaignId: 1,
      • CompanyId: 10,
      • CreatedAt: "2015-01-02T15:19:03.036446Z",
      • Id: 123456789,
      • LastScoredAt: "2024-05-18T13:04:02.657514879-04:00",
      • RemediationStatus: "",
      • Score: 75,
      • Tags: null,
      • TrafficSourceId: 1,
      • Type: "email"
      },
    2. {
      • BrandId: 12,
      • CampaignId: 1,
      • CompanyId: 10,
      • CreatedAt: "2015-01-02T15:19:03.036446Z",
      • Id: 123456000,
      • LastScoredAt: "2024-05-18T11:47:02.657516977-04:00",
      • RemediationStatus: "",
      • Score: 100,
      • Tags: null,
      • TrafficSourceId: 2,
      • Type: "web",
      • Url: https://google.com
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • BrandId: 11,
    • CampaignId: 1,
    • CompanyId: 10,
    • CreatedAt: "2015-01-02T15:19:03.036446Z",
    • Id: 123456789,
    • LastScoredAt: "2024-05-18T13:04:02.657570257-04:00",
    • RemediationStatus: "",
    • Score: 175,
    • Tags: null,
    • TrafficSourceId: 1,
    • Type: "email"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Created: "2016-05-12T15:19:03.036446Z",
      • DueDate: "2016-05-15T15:19:03.036446Z",
      • Id: 123456789,
      • Note: "Who allowed this to happen?",
      • Owner: "Joe Person",
      • Status: "Closed no action required.",
      • User: "joe@company.com"
      },
    2. {
      • Created: "2016-05-12T15:19:03.036446Z",
      • DueDate: "2016-05-15T15:19:03.036446Z",
      • Id: 123456789,
      • Note: "",
      • Owner: "Joe Person",
      • Status: "Not Reviewed.",
      • User: "karen@company.com"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
tags Restrict results to the given Tag(s). &tags=red,blue
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
{
  • Results: [
    1. {
      • BrandId: 11,
      • CampaignId: 1,
      • CompanyId: 10,
      • CreatedAt: "2015-01-02T15:19:03.036446Z",
      • Id: 123456789,
      • LastScoredAt: "2024-05-18T13:04:02.657660094-04:00",
      • RemediationStatus: "",
      • Score: 75,
      • Tags: null,
      • TrafficSourceId: 1,
      • Type: "web",
      • Url: https://bing.com
      },
    2. {
      • BrandId: 12,
      • CampaignId: 1,
      • CompanyId: 10,
      • CreatedAt: "2015-01-02T15:19:03.036446Z",
      • Id: 123456000,
      • LastScoredAt: "2024-05-18T11:47:02.657662094-04:00",
      • RemediationStatus: "",
      • Score: 100,
      • Tags: null,
      • TrafficSourceId: 2,
      • Type: "web",
      • Url: https://google.com
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • BrandId: 12,
    • CampaignId: 1,
    • CompanyId: 10,
    • CreatedAt: "2015-01-02T15:19:03.036446Z",
    • Id: 987654,
    • LastScoredAt: "2024-05-18T11:47:02.657716978-04:00",
    • RemediationStatus: "",
    • Score: 100,
    • Tags: null,
    • TrafficSourceId: 2,
    • Type: "web",
    • Url: https://google.com
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Id: "PLSAG2BBHBZFCMHB5NYCV2QPR4YM",
      • Score: 73,
      • Title: "Certified Title.pdf"
      },
    2. {
      • Id: "PLL7ZWDBDAKFGKPGLOG24QAM4MFA",
      • Score: 97,
      • Title: "Loan Management.docx"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • BrandId: 1849,
    • CampaignId: 1543,
    • CasesIds: [
      1. "a739e196-990b-4581-8def-a14c1a360f7f"
      ],
    • DocumentType: "docx",
    • Id: "PLL7ZWDBDAKFGKPGLOG24QAM4MFA",
    • IngestionMethod: "email",
    • LastScoredAt: "2024-05-18T11:47:02.657784865-04:00",
    • Pages: 0,
    • Score: -25,
    • Submitter: "bob@company.com",
    • Title: "Loan Management.docx",
    • UploadDate: "2024-05-18T10:04:02.657784753-04:00"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Datetime: "2015-01-02T15:19:03.036446Z",
      • Deduction: 10,
      • ID: "PLL7ZWDBDAKFGKPGLOG24QAM4MFA",
      • Occurrences: 4,
      • RuleID: 456,
      • RuleName: "Things to not say",
      • RuleType: "BannedTermRule",
      • TermID: 1234,
      • TermName: "Do not say this!",
      • TermType: "root",
      • WordIndex: 325
      },
    2. {
      • Datetime: "2015-01-02T15:19:03.036446Z",
      • Deduction: 10,
      • ID: "PLL7ZWDBDAKFGKPGLOG24QAM4MFA",
      • Occurrences: 4,
      • RuleID: 456,
      • RuleName: "Things to not say",
      • RuleType: "BannedTermRule",
      • TermID: 1234,
      • TermName: "Do not say this!",
      • TermType: "root",
      • WordIndex: 467
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Id: "4d838c95-65cb-4420-84a5-6441184db912",
      • Title: "Staff Case"
      },
    2. {
      • Id: "fcd3c6cb-5193-46b1-b182-f837e5c187f5",
      • Title: "Loan Management"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • BrandID: "",
    • CaseNumber: "C343",
    • Comments: [
      1. {
        • Body: "I have started working on this",
        • UID: "bob@performline.com",
        • UpdatedAt: "2024-05-18T13:24:02.657872146-04:00"
        }
      ],
    • CreatedAt: "2024-05-18T10:04:02.657872346-04:00",
    • Description: "Staff created case",
    • DocumentIds: [
      1. "PLL7ZWDBDAKFGKPGLOG24QAM4MEA",
      2. "PLHKQBOKD4EJBXRJFOSAFSREZVX5"
      ],
    • Id: "2b0c1735-b488-476d-a525-f1f002c8da1b",
    • Labels: [
      1. {
        • CreatedAt: "2024-05-18T13:24:02.657872423-04:00",
        • ID: "e55530df-8aae-4b35-b850-15316790f899",
        • IsActive: true,
        • IsArchived: false,
        • Title: "A very cool label",
        • UpdatedAt: "2024-05-18T13:24:02.657872495-04:00"
        }
      ],
    • Owner: "bob@performline.com",
    • Queue: "Basic Queue",
    • State: "In Progress",
    • Title: "Merlin Case",
    • UpdatedAt: "2024-05-18T10:04:02.657872267-04:00"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Created: "2016-05-12T15:19:03.036446Z",
      • DueDate: "2016-05-15T15:19:03.036446Z",
      • Id: 123456789,
      • Note: "Who allowed this to happen?",
      • Owner: "Joe Person",
      • Status: "Closed no action required.",
      • User: "joe@company.com"
      },
    2. {
      • Created: "2016-05-12T15:19:03.036446Z",
      • DueDate: "2016-05-15T15:19:03.036446Z",
      • Id: 123456789,
      • Note: "",
      • Owner: "Joe Person",
      • Status: "Not Reviewed.",
      • User: "karen@company.com"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • ID: 123456789,
    • ScorableContent: "<html><div>Hello, welcome to our web page!</div></html>"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Datetime: "2015-01-02T15:19:03.036446Z",
      • ID: 987654,
      • Occurrences: 4,
      • PageID: 7392,
      • PageType: "web",
      • RuleID: 456,
      • RuleName: "Things to not say",
      • RuleType: "BannedTermRule",
      • TermID: 1234,
      • TermName: "Do not say this!"
      },
    2. {
      • Datetime: "2015-01-02T15:19:03.036446Z",
      • ID: 987655,
      • Occurrences: 2,
      • PageID: 7392,
      • PageType: "web",
      • RuleID: 457,
      • RuleName: "Things to say",
      • RuleType: "RequiredTermRule",
      • TermID: 1235,
      • TermName: "Definitely say this!"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
  • 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
  • BrandID

    ID of the brand associated with this violation.

     String
  • CompanyID

    ID of the company associated with this violation.

     String
  • timestamps

    Timestamps for occurrences of this violation, in seconds (Call center only).

     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
{
  • Results: [
    1. {
      • Agent: "T111",
      • BrandId: 11,
      • CallId: "54312",
      • CallLength: "451",
      • CampaignId: 1,
      • CompanyId: 10,
      • CreatedAt: "2015-01-02T15:19:03.036446Z",
      • FileLocation: "/ftp/new_call_file.wav",
      • Id: 775000,
      • InquiryId: "7844",
      • LastScoredAt: "2024-05-18T13:04:02.658024262-04:00",
      • RecordedOn: "05/27/2019 14:41:46",
      • RemediationStatus: "",
      • Score: 75,
      • Tags: [
        1. "RP"
        ],
      • TrafficSourceId: 1,
      • Type: "callcenter"
      },
    2. {
      • Agent: "T111",
      • BrandId: 12,
      • CallId: "54312",
      • CallLength: "451",
      • CampaignId: 1,
      • CompanyId: 10,
      • CreatedAt: "2015-01-02T15:19:03.036446Z",
      • FileLocation: "/ftp/new_call_file.wav",
      • Id: 775030,
      • InquiryId: "7844",
      • LastScoredAt: "2024-05-18T11:47:02.658026511-04:00",
      • RecordedOn: "05/27/2019 14:41:46",
      • RemediationStatus: "",
      • Score: 100,
      • Tags: null,
      • TrafficSourceId: 2,
      • Type: "callcenter"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • BrandId: 11,
    • CallId: "54312",
    • CampaignId: 1,
    • CompanyId: 10,
    • CreatedAt: "2015-01-02T15:19:03.036446Z",
    • FileLocation: "/ftp/new_call_file.wav",
    • Id: 775000,
    • InquiryId: "7844",
    • LastScoredAt: "2024-05-18T13:04:02.658096837-04:00",
    • RecordedOn: "05/27/2019 14:41:46",
    • RemediationStatus: "",
    • Score: 75,
    • Tags: null,
    • TrafficSourceId: 1,
    • Type: "callcenter"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Created: "2016-05-12T15:19:03.036446Z",
      • DueDate: "2016-05-15T15:19:03.036446Z",
      • Id: 123456789,
      • Note: "Who allowed this to happen?",
      • Owner: "Joe Person",
      • Status: "Closed no action required.",
      • User: "joe@company.com"
      },
    2. {
      • Created: "2016-05-12T15:19:03.036446Z",
      • DueDate: "2016-05-15T15:19:03.036446Z",
      • Id: 123456789,
      • Note: "",
      • Owner: "Joe Person",
      • Status: "Not Reviewed.",
      • User: "karen@company.com"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • ID: 123456789,
    • ScorableContent: "Hello this is the help desk! What can I help you with? ..."
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Datetime: "2015-01-02T15:19:03.036446Z",
      • ID: 987654,
      • Occurrences: 4,
      • PageID: 7392,
      • PageType: "callcenter",
      • Participant: "agent",
      • RuleID: 456,
      • RuleName: "Things to not say",
      • RuleType: "BannedTermRule",
      • TermID: 1234,
      • TermName: "Do not say this!",
      • timestamps: [
        1. 153,
        2. 982
        ]
      },
    2. {
      • Datetime: "2015-01-02T15:19:03.036446Z",
      • ID: 987655,
      • Occurrences: 2,
      • PageID: 7392,
      • PageType: "callcenter",
      • Participant: "caller",
      • RuleID: 457,
      • RuleName: "Things to say",
      • RuleType: "RequiredTermRule",
      • TermID: 1235,
      • TermName: "Definitely say this!",
      • timestamps: [
        1. 153,
        2. 982
        ]
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
  • 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
  • BrandID

    ID of the brand associated with this violation.

     String
  • CompanyID

    ID of the company associated with this violation.

     String
  • timestamps

    Timestamps for occurrences of this violation, in seconds (Call center only).

     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
{
  • Results: [
    1. {
      • Agent: "Olivia R",
      • BrandId: 11,
      • CampaignId: 1,
      • CompanyId: 10,
      • CreatedAt: "2015-01-02T15:19:03.036446Z",
      • Duration: "120",
      • Id: 796156,
      • LastScoredAt: "2024-05-18T13:04:02.658267092-04:00",
      • RemediationStatus: "",
      • Score: 75,
      • SessionId: "12345",
      • Tags: null,
      • TrafficSourceId: 1,
      • Type: "chat",
      • Visitor: "Joe Smith",
      • WordCount: "1324"
      },
    2. {
      • Agent: "Kyle S",
      • BrandId: 12,
      • CampaignId: 1,
      • CompanyId: 10,
      • CreatedAt: "2015-01-02T15:19:03.036446Z",
      • Duration: "120",
      • Id: 552879,
      • LastScoredAt: "2024-05-18T11:47:02.658269219-04:00",
      • RemediationStatus: "",
      • Score: 100,
      • Tags: null,
      • TrafficSourceId: 2,
      • Type: "chat",
      • Visitor: "Joe Smith",
      • WordCount: "1324"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • Agent: "Kyle S",
    • BrandId: 11,
    • CampaignId: 1,
    • CompanyId: 10,
    • CreatedAt: "2015-01-02T15:19:03.036446Z",
    • Duration: "120",
    • Id: 796156,
    • LastScoredAt: "2024-05-18T13:04:02.65835198-04:00",
    • RemediationStatus: "",
    • Score: 75,
    • SessionId: "12345",
    • Tags: null,
    • TrafficSourceId: 1,
    • Type: "chat",
    • Visitor: "Joe Smith",
    • WordCount: "1324"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Created: "2016-05-12T15:19:03.036446Z",
      • DueDate: "2016-05-15T15:19:03.036446Z",
      • Id: 123456789,
      • Note: "Who allowed this to happen?",
      • Owner: "Joe Person",
      • Status: "Closed no action required.",
      • User: "joe@company.com"
      },
    2. {
      • Created: "2016-05-12T15:19:03.036446Z",
      • DueDate: "2016-05-15T15:19:03.036446Z",
      • Id: 123456789,
      • Note: "",
      • Owner: "Joe Person",
      • Status: "Not Reviewed.",
      • User: "karen@company.com"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • ID: 123456789,
    • ScorableContent: "John: Hello, how can I help you today?"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Datetime: "2015-01-02T15:19:03.036446Z",
      • ID: 987654,
      • Occurrences: 4,
      • PageID: 7392,
      • PageType: "chat",
      • Participant: "agent",
      • RuleID: 456,
      • RuleName: "Things to not say",
      • RuleType: "BannedTermRule",
      • TermID: 1234,
      • TermName: "Do not say this!"
      },
    2. {
      • Datetime: "2015-01-02T15:19:03.036446Z",
      • ID: 987655,
      • Occurrences: 2,
      • PageID: 7392,
      • PageType: "chat",
      • Participant: "visitor",
      • RuleID: 456,
      • RuleName: "Things to say",
      • RuleType: "RequiredTermRule",
      • TermID: 1235,
      • TermName: "Definitely say this!"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
  • 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
  • BrandID

    ID of the brand associated with this violation.

     String
  • CompanyID

    ID of the company associated with this violation.

     String
  • timestamps

    Timestamps for occurrences of this violation, in seconds (Call center only).

     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
{
  • Results: [
    1. {
      • BrandId: 11,
      • CampaignId: 1,
      • CompanyId: 10,
      • CreatedAt: "2015-01-02T15:19:03.036446Z",
      • EmailRecipient: "joe@company.com",
      • EmailSender: "bob@company.com",
      • Id: 784234,
      • LastScoredAt: "2024-05-18T13:04:02.658514317-04:00",
      • RemediationStatus: "Escalated",
      • Score: 75,
      • Tags: null,
      • TrafficSourceId: 1,
      • Type: "email"
      },
    2. {
      • BrandId: 12,
      • CampaignId: 1,
      • CompanyId: 10,
      • CreatedAt: "2015-01-02T15:19:03.036446Z",
      • EmailRecipient: "joe@company.com",
      • EmailSender: "bob@company.com",
      • Id: 489512,
      • LastScoredAt: "2024-05-18T11:47:02.658516998-04:00",
      • RemediationStatus: "Not reviewed",
      • Score: 100,
      • Tags: null,
      • TrafficSourceId: 2,
      • Type: "email"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • BrandId: 11,
    • CampaignId: 1,
    • CompanyId: 10,
    • CreatedAt: "2015-01-02T15:19:03.036446Z",
    • Id: 784234,
    • LastScoredAt: "2024-05-18T13:04:02.65857433-04:00",
    • RemediationStatus: "",
    • Score: 75,
    • Tags: null,
    • TrafficSourceId: 1,
    • Type: "email"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Created: "2016-05-12T15:19:03.036446Z",
      • DueDate: "2016-05-15T15:19:03.036446Z",
      • Id: 123456789,
      • Note: "Who allowed this to happen?",
      • Owner: "Joe Person",
      • Status: "Closed no action required.",
      • User: "joe@company.com"
      },
    2. {
      • Created: "2016-05-12T15:19:03.036446Z",
      • DueDate: "2016-05-15T15:19:03.036446Z",
      • Id: 123456789,
      • Note: "",
      • Owner: "Joe Person",
      • Status: "Not Reviewed.",
      • User: "karen@company.com"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • ID: 123456789,
    • ScorableContent: "<html><head>IMPORTANT EMAIL</head></html>"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Datetime: "2015-01-02T15:19:03.036446Z",
      • ID: 987654,
      • Occurrences: 4,
      • PageID: 7392,
      • PageType: "email",
      • RuleID: 456,
      • RuleName: "Things to not say",
      • RuleType: "BannedTermRule",
      • TermID: 1234,
      • TermName: "Do not say this!"
      },
    2. {
      • Datetime: "2015-01-02T15:19:03.036446Z",
      • ID: 987655,
      • Occurrences: 2,
      • PageID: 7392,
      • PageType: "email",
      • RuleID: 457,
      • RuleName: "Things to say",
      • RuleType: "RequiredTermRule",
      • TermID: 1235,
      • TermName: "Definitely say this!"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
  • 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
  • BrandID

    ID of the brand associated with this violation.

     String
  • CompanyID

    ID of the company associated with this violation.

     String
  • timestamps

    Timestamps for occurrences of this violation, in seconds (Call center only).

     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
{
  • Results: [
    1. {
      • BrandId: 11,
      • CampaignId: 1,
      • CompanyId: 10,
      • CreatedAt: "2015-01-02T15:19:03.036446Z",
      • Id: 123456789,
      • LastScoredAt: "2024-05-18T13:04:02.658724514-04:00",
      • RemediationStatus: "",
      • Score: 75,
      • Tags: null,
      • TrafficSourceId: 1,
      • Type: "social"
      },
    2. {
      • BrandId: 12,
      • CampaignId: 1,
      • CompanyId: 10,
      • CreatedAt: "2015-01-02T15:19:03.036446Z",
      • Id: 123456000,
      • LastScoredAt: "2024-05-18T11:47:02.658726494-04:00",
      • RemediationStatus: "",
      • Score: 100,
      • Tags: null,
      • TrafficSourceId: 2,
      • Type: "social"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • BrandId: 12,
    • CampaignId: 1,
    • CompanyId: 10,
    • CreatedAt: "2015-01-02T15:19:03.036446Z",
    • Id: 987654,
    • LastScoredAt: "2024-05-18T11:47:02.658778538-04:00",
    • RemediationStatus: "",
    • Score: 100,
    • Tags: null,
    • TrafficSourceId: 2,
    • Type: "social"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Created: "2016-05-12T15:19:03.036446Z",
      • DueDate: "2016-05-15T15:19:03.036446Z",
      • Id: 123456789,
      • Note: "Who allowed this to happen?",
      • Owner: "Joe Person",
      • Status: "Closed no action required.",
      • User: "joe@company.com"
      },
    2. {
      • Created: "2016-05-12T15:19:03.036446Z",
      • DueDate: "2016-05-15T15:19:03.036446Z",
      • Id: 123456789,
      • Note: "",
      • Owner: "Joe Person",
      • Status: "Not Reviewed.",
      • User: "karen@company.com"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: {
    • ID: 123456789,
    • ScorableContent: "Wow, Company X is the greatest company ever! #CompanyBirthday"
    },
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
{
  • Results: [
    1. {
      • Datetime: "2015-01-02T15:19:03.036446Z",
      • ID: 987654,
      • Occurrences: 4,
      • PageID: 7392,
      • PageType: "web",
      • RuleID: 456,
      • RuleName: "Things to not say",
      • RuleType: "BannedTermRule",
      • TermID: 1234,
      • TermName: "Do not say this!"
      },
    2. {
      • Datetime: "2015-01-02T15:19:03.036446Z",
      • ID: 987655,
      • Occurrences: 2,
      • PageID: 7392,
      • PageType: "web",
      • RuleID: 457,
      • RuleName: "Things to say",
      • RuleType: "RequiredTermRule",
      • TermID: 1235,
      • TermName: "Definitely say this!"
      }
    ],
  • ServiceName: "",
  • Status: "success",
  • StatusCode: 200
}
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
  • 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
  • BrandID

    ID of the brand associated with this violation.

     String
  • CompanyID

    ID of the company associated with this violation.

     String
  • timestamps

    Timestamps for occurrences of this violation, in seconds (Call center only).

     Other