Notes, Annotations etc are stored as objects in the data stores, these objects, along with the data stored have additional properties such as a created_date. All properties of an object are returned for that object, there is no requirement to specify what is returned.

Note

A note object represents a single text based note attached to a Social Media Author. The following properties appear on a note

Property Description Variations
action action type that created this note add_note, modify_note
created_date ISO datetime of the action N/A
author see explanation of author object N/A
id unique ID of the note N/A
text contents of the note N/A
user ID of the agent that created or modified this note N/A

JSON view of a note object

{
      "action": "add_note",
      "created_date": "2016-03-15T17:48:49",
      "author": {
        "author_ids": [
          "t:2825986021"
        ],
        "customer_profiles_id": "564b5d829bd56c14074805f0"
      },
      "id": "56e84b019bd56c6a6c692a5a",
      "text": "A Thaum is the basic unit of magical strength. It has been universally established as the amount of magic needed to create one small white pigeon or three normal-sized billiard balls",
      "user": 16
}

Annotation

An annotation is a key value piece of data that is stored against a Social Media Author. The annotations have types which are created through the Conversocial interface, which act as the key. For instance, one of the default types is "Email" and an email value can be stored against it.

"email": "rincewind@unseenuniversity.disc"

The annotations are exposed as an object with its value and its type. The following properties appear on an annotation

Property Description Variations
action action type that created this annotation add_note, modify_note
created_date ISO datetime of the action N/A
author see explanation of author object N/A
id unique ID of the annotation N/A
text value of the annotation N/A
type_id see explanation of annotation types N/A
user ID of the agent that created or modified this annotation N/A

JSON view of an annotation object

{
      "action": "add_annotation",
      "created_date": "2015-11-17T17:02:06",
      "author": {
        "author_ids": [
          "t:2825986021"
        ],
        "customer_profiles_id": "564b5d829bd56c14074805f0"
      },
      "id": "564b5d8e9bd56c14074805f2",
      "text": "rincewind@unseenuniversity.ac.disc",
      "type_id": "564b5d709bd56c14074805ec",
      "user": 16
}


Annotation Types

An annotation_type is the key for an annotation. These are created through Conversocial and every annotation will have a type_id that corresponds to an annotation_type.

Property Description Variations
format short, long
id the ID of the annotation type
is_active whether this field can currently be used by agents true / false
name the name of the annotation type

JSON view of an annotation-type

{
  "format": "short",
  "id": "564b5d709bd56c14074805ec",
  "is_active": true,
  "name": "Wizard Rank"
}


Tags

A tag is a simple string attached to a Customer Profile. Any number of tags can be attached to a Social Media Author as long as these have been defined through the Conversocial interface. In a similar fashion to notes, and annotations, tags are represented by a tag object with properties.

Property Description Variations
action action type that created this tag add_tag, modify_tag
created_date ISO datetime of the action N/A
author see explanation of author object N/A
id unique ID of the tag N/A
name the tag name N/A
user ID of the agent that created or modified this annotation N/A

JSON view of a tag object

{
      "action": "add_tag",
      "created_date": "2015-12-29T13:24:11.075000",
      "author": {
        "author_ids": [
          "t:123456"
        ],
        "customer_profiles_id": "5682897b9bd56c0cba207aa3"
      },
      "id": "5682897b9bd56c0cba207aa2",
      "name": "wizard",
      "user": 1
}


Author

The author is a single object encompassing all data in Customer profiles, stored against that _author_id.

The author objects property author is itself an object that details the Conversocial author ID and the Customer Profiles internal ID. Each Social Media Author in Conversocial has an ID, this is known as the author_id. This author_id is the Social Media platforms unique ID prepended with a letter e.g. a Facebook author_id will look something like f:123121231231 whereas a Twitter author_id will be prepended with t:.

Property Description
author_ids a list of the author IDs in Conversocial which are attached to this Customer profile
customer_profiles_id the ID of this Customer profile 
    "author": {
        "author_ids": [
          "t:2825986021"
        ],
        "customer_profiles_id": "564b5d829bd56c14074805f0"
    },

An author fully represents all active properties of an Authors Profile. Retrieved by its author_id property, it returns all notes, annotations, and tags.

Property Description
annotations a list of annotations. see explanation of annotations
notes a list of notes. see explanation of notes
tags a list of tags. see explanation of tags
author see explanation of author object

JSON view of an author

{
  "customer": {
        "annotations": [
            {
              "action": "add_annotation",
              "created_date": "2015-11-17T17:02:06",
              "id": "564b5d8e9bd56c14074805f2",
              "text": "rincewind@unseenuniversity.ac.disc",
              "type_id": "564b5d709bd56c14074805ec",
              "user": 16
            },
            {
              "action": "add_annotation",
              "created_date": "2015-11-19T15:05:30",
              "id": "564de53a9bd56c1c9c89e375",
              "text": "1-800-get-magic",
              "type_id": "564b5d709bd56c14074805ed",
              "user": 16
            }
        ],
        "author": {
            "author_ids": [
              "t:2825986021"
            ],
            "customer_profiles_id": "564b5d829bd56c14074805f0"
        },
        "notes": [
            {
              "action": "add_note",
              "created_date": "2016-03-15T17:48:49",
              "id": "56e84b019bd56c6a6c692a5a",
              "text": "A Thaum is the basic unit of magical strength. It has been universally established as the amount of magic needed to create one small white pigeon or three normal-sized billiard balls",
              "user": 16
            }
        ],
        "tags": [
            {
              "action": "add_tag",
              "created_date": "2015-12-29T13:24:11.075000",
              "author": {
                "author_ids": [
                  "t:123456"
                ],
                "customer_profiles_id": "5682897b9bd56c0cba207aa3"
              },
              "id": "5682897b9bd56c0cba207aa2",
              "name": "wizard",
              "user": 1
            }
        ]
  },
  "status_code": 200,
  "success": true
}