Page tree
Skip to end of metadata
Go to start of metadata

 

Get /social

Provides the entire list of  social entries

Returns the entire list of  socials. A deal can have 1 or more revenue buckets depending on the business model. Each revenue bucket has its own behaviour in terms of average selling price, length, renewal probability, recognition policy (percentage paid at the start, monthy and end). A bucket can be a product line, a service, a license, etc.

All associated configuration is intended for the Revenue Planer capacity for the future.

Request URL

https://{client_id}.salesseek.net/api/social

Response Type

Response content type: JSON Array[Social]

ModelExample of Response
Array[Social]

Social {

author_id(string): id of the individual who posted this social entry,

author_name(string): name of the individual who posted this social entry,

author_photo_url(string): entire url for an image assigned to the Individual who posted this social entry,

author_username(string): username (from the corresponding social network) who posted this social entry,

client_id(string): the unique reference to the SalesSeek Account,

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

creator_id: unique identifier for the User who created the activity,

id(string): unique identifier for the communication,

is_processed(boolean): true or false if this social entry has been processed,

item_id(string): unique identifier for the communication on the social network,

item_type(enum): tweet or post,

last_modified_by_id(string): id of the User who modified this activity (if haven't been modified = creator id),

latest(boolean): true or false if this is the latest social associated to this individual,

modified(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

network(enum): twitter or facebook,

owner_id(string): unique identifier for the User who owns the activity, is typically the creator, but can be modified,

short_id(string): alias or shorter, but still unique, identifier for this social entry,

text(string): Entire content of the social post,

type(string): "social_items",

owner(JSON): {

id(string): unique identifier for the SalesSeek User who owns the activity,

name(string): Name of the SalesSeek user who owns this social entry

}

author: {

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

first_name(string): first name of the individual who posted this social entry,

id(string): id of the individual who posted this social entry,

last_name(string): last name of the individual who posted this social entry,

photo_url(string): entire url for an image assigned to the Individual who posted this social entry,

short_id(string): shorter, but still unique, identifier for the author of this social entry,

}

 

[
  0:{
    author_id: "6a4fdfab",
    author_name: "Rob Johnson",
    author_photo_url: "https://pbs.twimg.com/prsss.png",
    author_username: "robjohnson",
    client_id: "913fa92ea",
    created: "2014-01-19T11:59:04",
    creator_id: "9dab6268",
    id: "ba867e00c0",
    is_processed: false,
    item_id: "51680",
    item_type: "tweet",
    last_modified_by_id: "9db6268",
    latest: true,
    modified: "2014-01-19T12:01:38.991564",
    network: "twitter",
    owner_id: "94444da8",
    short_id: "94444d",
    text: "A Sales Professional! http://t.co/oYAEDoc @mikebrook",
    type: "social_items",
    owner: {
      id: "94444da8",
      name: "Mike Brown"
    }
    author: {
      created: "2014-02-13T10:01:09.829480",
      first_name: "Rob",
      id: "6a4fdfab",
      last_name: "Johnson",
      photo_url: "data:image/jpeg;base64,/9QZ.jpg",
      short_id: "6a4b"
  }
  , 1:{...}
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Records-RowsOut-

Amount of records returned in this search

int
Records-StartOut-The index of the first row on the response (in case there are more results, paginated)int
Records-TotalOut-Total amount of records (even if are not in this search result)int
rowsInNThe maximum amount of element to be requestedint
startInNThe element number to start to retrieve the data (0 for the first position)int

 


 

Get /social/{social _id} 

Provides the social entry matching social _id

Returns the unique social entry matching social _id

Request URL

https://{client_id}.salesseek.net/api/social/69d1fbe62

Response Type

Response content type: JSON(Social)

ModelExample of Response

 

Social {

author_id(string): id of the individual who posted this social entry,

author_name(string): name of the individual who posted this social entry,

author_photo_url(string): entire url for an image assigned to the Individual who posted this social entry,

author_username(string): username (from the corresponding social network) who posted this social entry,

client_id(string): the unique reference to the SalesSeek Account,

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

creator_id: unique identifier for the User who created the activity,

id(string): unique identifier for the communication,

is_processed(boolean): true or false if this social entry has been processed,

item_id(string): unique identifier for the communication on the social network,

item_type(enum): tweet or post,

last_modified_by_id(string): id of the User who modified this activity (if haven't been modified = creator id),

latest(boolean): true or false if this is the latest social associated to this individual,

modified(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

network(enum): twitter or facebook,

owner_id(string): unique identifier for the User who owns the activity, is typically the creator, but can be modified,

short_id(string): alias or shorter, but still unique, identifier for this social entry,

text(string): Entire content of the social post,

type(string): "social_items",

owner(JSON): {

id(string): unique identifier for the SalesSeek User who owns the activity,

name(string): Name of the SalesSeek user who owns this social entry

}

author: {

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

first_name(string): first name of the individual who posted this social entry,

id(string): id of the individual who posted this social entry,

last_name(string): last name of the individual who posted this social entry,

photo_url(string): entire url for an image assigned to the Individual who posted this social entry,

short_id(string): shorter, but still unique, identifier for the author of this social entry,

}

{
    author_id: "6a4fdfab",
    author_name: "Rob Johnson",
    author_photo_url: "https://pbs.twimg.com/profile_images/4sss.png",
    author_username: "robjohnson",
    client_id: "913fa92ea",
    created: "2014-01-19T11:59:04",
    creator_id: "9dab6268",
    id: "ba867e00c0",
    is_processed: false,
    item_id: "51680",
    item_type: "tweet",
    last_modified_by_id: "9db6268",
    latest: true,
    modified: "2014-01-19T12:01:38.991564",
    network: "twitter",
    owner_id: "94444da8",
    short_id: "94444d",
    text: "A Sales Professional! http://t.co/oYAEDoc @mikebrook",
    type: "social_items",
    owner: {
      id: "94444da8",
      name: "Mike Brown"
    }
    author: {
      created: "2014-02-13T10:01:09.829480",
      first_name: "Rob",
      id: "6a4fdfab",
      last_name: "Johnson",
      photo_url: "data:image/jpeg;base64,/9QZ.jpg",
      short_id: "6a4b"
    }
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 social  _idInYThe id of   social   to be getstring
 social Out-The  requested  social  JSON

 

 


 

 

PATCH /social/{social _id}

Update a specific social entry by its ID

Updates a specific social entry by {social _id} and Returns the resulting  element . The fields updated are just the ones passed on the request body

Request URL

https://{client_id}.salesseek.net/api/social/a3451f5--640585a5d026

Request Body
{
    is_processed: true,
    owner:{
        client_id: "913fa2ea",
        email_address: "hello@gmail.net",
        favorites_id: "d5653db54",
        ical_url: "/users/fc194a",
        id: "fc194f6b94",
        is_admin: false,
        name: "Clare Donnald",
        password_reset_required: false,
        preferences: {
            default_dashboard: "team"
        }
        quota: [
            0: {
                value:0, 
                bucket_id:21509fd
            },
            1: {
                value:0, 
                bucket_id:ecd2982c0
            }
        short_id: "e581554",
        type: "users"
    }
    owner_id: "fc194f6b94"
}

 

Response Type

Response content type: JSON social

ModelExample of Response

 

Social {

author_id(string): id of the individual who posted this social entry,

author_name(string): name of the individual who posted this social entry,

author_photo_url(string): entire url for an image assigned to the Individual who posted this social entry,

author_username(string): username (from the corresponding social network) who posted this social entry,

client_id(string): the unique reference to the SalesSeek Account,

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

creator_id: unique identifier for the User who created the activity,

id(string): unique identifier for the communication,

is_processed(boolean): true or false if this social entry has been processed,

item_id(string): unique identifier for the communication on the social network,

item_type(enum): tweet or post,

last_modified_by_id(string): id of the User who modified this activity (if haven't been modified = creator id),

latest(boolean): true or false if this is the latest social associated to this individual,

modified(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

network(enum): twitter or facebook,

owner_id(string): unique identifier for the User who owns the activity, is typically the creator, but can be modified,

short_id(string): alias or shorter, but still unique, identifier for this social entry,

text(string): Entire content of the social post,

type(string): "social_items",

owner(JSON): {

id(string): unique identifier for the SalesSeek User who owns the activity,

name(string): Name of the SalesSeek user who owns this social entry

}

author: {

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

first_name(string): first name of the individual who posted this social entry,

id(string): id of the individual who posted this social entry,

last_name(string): last name of the individual who posted this social entry,

photo_url(string): entire url for an image assigned to the Individual who posted this social entry,

short_id(string): shorter, but still unique, identifier for the author of this social entry,

}

{
    author_id: "6a4fdfab",
    author_name: "Rob Johnson",
    author_photo_url: "https://pbs.twimg.com/profile_images/4sss.png",
    author_username: "robjohnson",
    client_id: "913fa2ea",
    created: "2014-01-19T11:59:04",
    creator_id: "9dab6268",
    id: "fc194f6b94",
    is_processed: true,
    item_id: "51680",
    item_type: "tweet",
    last_modified_by_id: "9db6268",
    latest: true,
    modified: "2014-01-19T12:01:38.991564",
    network: "twitter",
    owner_id: "94444da8",
    short_id: "94444d",
    text: "Being A Sales Professional! http://t.co/oYAEDoc @mikebrook",
    type: "social_items",
    owner: {
      id: "fc194f6b94",
      name: "Clare Donnald"
    }
    author: {
      created: "2014-02-13T10:01:09.829480",
      first_name: "Rob",
      id: "913fa2ea",
      last_name: "Johnson",
      photo_url: "data:image/jpeg;base64,/9QZ.jpg",
      short_id: "6a4b"
    }
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 social _idInYThe id of the  social  to be updatedstring
 social InYThe subset of the  social  model fields to be updatedJSON
 social OutThe  social  after the successful updateJSON
  • No labels