Transcription Keyword Groups

A named group of keywords that Trackdrive spots within call transcriptions to flag calls automatically.

GET /transcription_keyword_groups

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/transcription_keyword_groups

List Keyword Group records.

Lists Keyword Groups, which bundle the transcription keywords used to flag or tag calls whose transcript matches specific words or phrases.

Params

Param name Description
ids
Optional

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
page
Optional

Return the next page of results.

  • Must be a number.
per_page
Optional

How many results to return per page. The default is 25.

  • Must be a number.
created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String
created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String
fulltext
Optional

Search for any record that matches this text

  • Must be a String
time_zone
Optional

Date ranges will be parsed using this time zone.
columns
Optional 		Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • company_id
  • name
  • description

  • Must be a String
root
Optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /transcription_keyword_groups/new

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/transcription_keyword_groups/new

Build Keyword Group with defaults.

Returns a blank Keyword Group populated with default attribute values (name defaults to "Keyword Group"), without saving it.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String
description
Optional Blank value allowed

Description

  • Must be a String

POST /transcription_keyword_groups

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/transcription_keyword_groups

Create Keyword Group.

Creates a Keyword Group. Add individual keywords to it separately to start matching against call transcripts.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String
description
Optional Blank value allowed

Description

  • Must be a String

GET /transcription_keyword_groups/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/transcription_keyword_groups/:id

Get Keyword Group by id.

Fetches a single Keyword Group by id.

PUT /transcription_keyword_groups/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/transcription_keyword_groups/:id

Update Keyword Group by id.

Updates a Keyword Group's name.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String
description
Optional Blank value allowed

Description

  • Must be a String

DELETE /transcription_keyword_groups/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/transcription_keyword_groups/:id

Destroy Keyword Group by id.

Deletes a Keyword Group by id, along with the keyword matching it provided for any calls that referenced it.