Skip to main content
POST
/
metadata-ingestion
/
v1
/
single-agent-metadata
Add an agent metadata
curl --request POST \
  --url https://api.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '
{
  "externalAgentId": "agent158",
  "startTs": "2022-07-08T11:15:53.237517000Z",
  "lobId": "1038",
  "lobName": "manufacturing",
  "groupId": "group5",
  "groupName": "XYZ",
  "agentName": "Jane Doe",
  "agentLocation": "Northern-California",
  "supervisorId": "3080",
  "supervisorName": "Linda Lemon",
  "languages": [
    "en-us",
    "zh-hans-hk"
  ],
  "concurrency": 3,
  "categoryLabel": "Tier-2-Escalation",
  "accountAccessLevel": "High-Profile",
  "ranking": 78,
  "vendor": "Contracting",
  "jobTitle": "Booking-Manager",
  "jobRole": "booking",
  "workShift": "afternoon",
  "emailAddress": "jdoe@example.com",
  "attributes": [
    {
      "name": "attr1_name",
      "value": "attr1_value"
    },
    {
      "name": "attr2_name",
      "value": "attr2_value"
    }
  ]
}
'
{
  "result": {
    "eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
    "error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
  }
}

Authorizations

​
asapp-api-id
string
header
required
​
asapp-api-secret
string
header
required

Body

application/json

A set of agent metadata attributes

​
externalAgentId
string
required

The agent id in question

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"agent158"

​
eventId
string | null

An event id used to track the submission; if none is provided, service will generate one

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"eventId-158"

​
startTs
string<date-time> | null

The date and time when the agent is hired in ISO-8601

Example:

"2022-07-08T11:15:53.237517000Z"

​
lobId
string | null

The line of business id

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"1038"

​
lobName
string | null

The descriptive name of the line of business

Maximum string length: 256
Example:

"manufacturing"

​
groupId
string | null

The group id of which the agent belong to

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"group5"

​
groupName
string | null

The descriptive name of the group

Maximum string length: 256
Example:

"XYZ"

​
agentName
string | null

The name of the agent

Maximum string length: 256
Example:

"Jane Doe"

​
agentLocation
string | null

The location (or address) of where the agent worked

Maximum string length: 256
Example:

"Northern-California"

​
supervisorId
string | null

The supervisor id of who the agent report to

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"3080"

​
supervisorName
string | null

The name of the agent's supervisor

Maximum string length: 256
Example:

"Linda Lemon"

​
languages
string[] | null

A list of agent's known language codes in ISO 639 e.g., English (United States) code = en-US

Maximum string length: 16
Pattern: [a-zA-Z0-9\-]+
Example:
["en-us", "zh-hans-hk"]
​
concurrency
integer | null

The number of issues that an agent can take at a time

Example:

3

​
categoryLabel
string | null

The category label that indicates the types of workflows an agent have access to or problems they solved

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"Tier-2-Escalation"

​
accountAccessLevel
string | null

The levels of mapping that an agent have access to make changes to customer accounts

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"High-Profile"

​
ranking
integer | null

Some numerical value indicating relative or absolute performance on a single scale

Example:

78

​
vendor
string | null

Vendor or BPO (Business Process Outsourcing) that the agent is part of

Maximum string length: 256
Example:

"Contracting"

​
jobTitle
string | null

The agent's job title

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"Booking-Manager"

​
jobRole
string | null

The agent's role

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"booking"

​
workShift
string | null

The hours or shift name they work

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"afternoon"

​
emailAddress
string<email> | null

The agent's email address

Example:

"jdoe@example.com"

​
attributes
object[] | null

A map of key-value pairs for extra metadata attributes

Maximum array length: 10
Example:
[
  {
    "name": "attr1_name",
    "value": "attr1_value"
  },
  {
    "name": "attr2_name",
    "value": "attr2_value"
  }
]

Response

200 - Success Submit a single item to the service to be ingested. Record can be traced back to the submitted record by the eventId. A message sent status will be returned with no error message for successful input checks.

​
result
object
required

A response with the status of a sent message

Example:
{
  "eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
  "error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}