PerformLine

PerformLine API Specification

Version 0.1.5

Overview

Response Objects

The API responds to all requests with a standardized response structure the 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 /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/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/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/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
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

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

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
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

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

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
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

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
  • Url

    The URL of the item being monitored (if applicable).

    String
  • LastScoredAt

    The date/time the item was last scored.

    Time

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
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

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
  • 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

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
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

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