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

 

Get /smart_groups

Provides the entire list of smart groups

Returns the entire list of  smart groups. Smart Groups are part of the workspace, containing Individuals for easily working with them in batches. Smartgroups are not populated manually, the user may define rules to act like an easy query language based on all the fields related to the individuals, opportunities and organizations, including custom fields.

This list of smart_groups may contain static groups or smart groups.

Request URL

https://aptui.salesseek.info/api/smart_groups

Response Type

Response content type: JSON Array[smart_groups]

ModelExample of Response
Array[smart_groups]

Group  {

cost (double): Cost associated to get this group,

comments (string): additional comments about this group,

cost_basis (Enum): directly related wit the cost field, in case its specified this represents if that cost is for the entire group (total) or if the cost is per lead (cpl),

group_type (Enum): Can be static or smart depending if the group is static snapshot list of elements (added manually), or a list of filters to apply a s a live query to get the elements

element_type (Enum): Can be one of the following "Individuals", "Organizations" or "Deals" depending on the type of items to be inserted into this group

id (string): unique identifier for this group,

owner_id (string): unique id from the SalesSeek user who is the owner of this group (by default the creator)

name (int): group name to be shown,

permision (Array): ???,

columns (Array): Array of columns to be shown,

filter_id (string): unique ID for the set of filters applyed,

rules(Array(RuleSet)): list of different RuleSets, if more than one on this Array an AND clause will be applied between all RuleSets belonging to this Array

}

 RuleSet(Array(Rule)): Set of rules for querying, if more than one and OR clause is applied to this current RuleSet,

 

Rule(JSON) {

field(string): Any field name indirectly related to individuals ( any from individual, organization, opportunity, communications, etc),

operator(Enum): one of the following values: contains, equal, empty, starts_with, ends_with,within_last, more_than,

value(values): might be a String for the value of this field, or a new JSON if the operator is related to a timestamp,

not(boolean): true for applying a negation over the current rule, false or empty otherwise

}

values(JSON) {

value(string): value asigned by the user,

unit(string): depending on the timestamp unit this might be h, d, m or y for those rules based on a relative time ago

}

 

[
  0:{
    cost: 100,
    comments: "All users from the UK",
    cost_basis: "total",
    id: "ee3b271a38",
    name: "UK Contacts",
    permissions: [
      0: "salesseek.core.all_permissions",
      1: "salesseek.core.edit",
      2: "salesseek.core.view"
    ]
    short_id: "ee3bda38",
    type: "smart_group"
  },
  1: {
    cost: 0,
    comments:"",
    cost_basis: "total",
    id: "5262be4ca6",
    name: "Universe",
    permissions: [
      0: "salesseek.core.all_permissions",
      1: "salesseek.core.edit",
      2: "salesseek.core.view"
    ]
    short_id: "526ca6",
    type: "smart_groups"
  }
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Records-RowsOut-

Amount of records returned in this search

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

 


 

POST /smart_groups

Creates a new smart group

Creates a new static smart_group based on the information provided in the request body

 

Request URL

https://aptui.salesseek.info/api/smart_groups

Request Body
{
    cost: 100,
    comments: "Users registered on our website, from natural search",
    cost_basis: "total",
    name: "Web Registrants",
    type: "smart_groups"
}

 

Response Type

Response content type: JSON smart_group

ModelExample of Response

 

Group  {

cost (double): Cost associated to get this group,

comments (string): additional comments about this group,

cost_basis (Enum): directly related wit the cost field, in case its specified this represents if that cost is for the entire group (total) or if the cost is per lead (cpl),

group_type (Enum): Can be static or smart depending if the group is static snapshot list of elements (added manually), or a list of filters to apply a s a live query to get the elements

element_type (Enum): Can be one of the following "Individuals", "Organizations" or "Deals" depending on the type of items to be inserted into this group

id (string): unique identifier for this group,

owner_id (string): unique id from the SalesSeek user who is the owner of this group (by default the creator)

name (int): group name to be shown,

permision (Array): ???,

columns (Array): Array of columns to be shown,

filter_id (string): unique ID for the set of filters applyed,

rules(Array(RuleSet)): list of different RuleSets, if more than one on this Array an AND clause will be applied between all RuleSets belonging to this Array

}

 RuleSet(Array(Rule)): Set of rules for querying, if more than one and OR clause is applied to this current RuleSet,

 

Rule(JSON) {

field(string): Any field name indirectly related to individuals ( any from individual, organization, opportunity, communications, etc),

operator(Enum): one of the following values: contains, equal, empty, starts_with, ends_with,within_last, more_than,

value(values): might be a String for the value of this field, or a new JSON if the operator is related to a timestamp,

not(boolean): true for applying a negation over the current rule, false or empty otherwise

}

values(JSON) {

value(string): value asigned by the user,

unit(string): depending on the timestamp unit this might be h, d, m or y for those rules based on a relative time ago

}

 

{
    cost: 100,
    comments: "Users registered on our website, from natural search",
    cost_basis: "total",
    id: "ee3b271a39",
    name: "Web Registrants",
    permissions: [
      0: "salesseek.core.all_permissions",
      1: "salesseek.core.edit",
      2: "salesseek.core.view"
    ]
    short_id: "ee3bda39",
    type: "smart_groups"
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
smart_groupOut-The  smart group  created after the successful request

 

Response BodyJSON
smart_groupInYBasic fields for creating a new smart groupRequest BodyJSON

 


 

 

DELETE /smart_groups

Deletes a list of smart groups by their IDs

Deletes a specific list smart groups specifying the list of IDs

Request URL

https://aptui.salesseek.info/api/smart_groups

Request Body
{
    0:{id: "fc8631c6c"},
    1:{id: "fc8635455"}
}

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 smart_groups_idsInYThe ids of the smart groups  to be deletedRequest PathArray[ids]

 


 

 

Get /smart_groups/{smart_group_id} 

Provides the smart group matching smart_group_id

Returns the unique  smart_group matching the smart_group _Id

Request URL

https://aptui.salesseek.info/api/smart_groups/69d1fbe62

Response Type

Response content type: JSON(smart_group)

ModelExample of Response

 

Group  {

cost (double): Cost associated to get this group,

comments (string): additional comments about this group,

cost_basis (Enum): directly related wit the cost field, in case its specified this represents if that cost is for the entire group (total) or if the cost is per lead (cpl),

group_type (Enum): Can be static or smart depending if the group is static snapshot list of elements (added manually), or a list of filters to apply a s a live query to get the elements

element_type (Enum): Can be one of the following "Individuals", "Organizations" or "Deals" depending on the type of items to be inserted into this group

id (string): unique identifier for this group,

owner_id (string): unique id from the SalesSeek user who is the owner of this group (by default the creator)

name (int): group name to be shown,

permision (Array): ???,

columns (Array): Array of columns to be shown,

filter_id (string): unique ID for the set of filters applyed,

rules(Array(RuleSet)): list of different RuleSets, if more than one on this Array an AND clause will be applied between all RuleSets belonging to this Array

}

 RuleSet(Array(Rule)): Set of rules for querying, if more than one and OR clause is applied to this current RuleSet,

 

Rule(JSON) {

field(string): Any field name indirectly related to individuals ( any from individual, organization, opportunity, communications, etc),

operator(Enum): one of the following values: contains, equal, empty, starts_with, ends_with,within_last, more_than,

value(values): might be a String for the value of this field, or a new JSON if the operator is related to a timestamp,

not(boolean): true for applying a negation over the current rule, false or empty otherwise

}

values(JSON) {

value(string): value asigned by the user,

unit(string): depending on the timestamp unit this might be h, d, m or y for those rules based on a relative time ago

}

 

{
    cost: 100,
    comments: "All users from the UK",
    cost_basis: "total",
    id: "ee3b271a39",
    name: "K Contacts on Jan 09, 2014",
    permissions: [
      0: "salesseek.core.all_permissions",
      1: "salesseek.core.edit",
      2: "salesseek.core.view"
    ]
    short_id: "ee3bda39",
    type: "smart_group"
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 smart_group  _idInYThe id of the smart_group to be obtainedRequest Pathstring
 smart_group Out-The  requested  smart_group  Response BodyJSON

 


 

PATCH /smart_groups/{smart_group _id}

Update a specific smart group  by its ID

Updates a  smart group  by {smart_group _id} and Returns the resulting  smart_group . The fields updated are just the ones passed on the request body

Request URL

https://aptui.salesseek.info/api/smart_groups/a3451f5

Request Body
{
  name: "Users from UK and name containing A or O",
  rules [
    0: [
 0: {
 field: "communication_value"
 operator: "contains"
 values: "44"
 }
 ],
    1: [
      0: {
        field: "individual_name"
        operator: "contains"
        values: "a"
      }
      1: {
        field: "individual_name"
        operator: "contains"
        values: "o"
      }
    ]
  ]
}

Response Type

Response content type: JSON smart_group

ModelExample of Response

 

Group  {

cost (double): Cost associated to get this group,

comments (string): additional comments about this group,

cost_basis (Enum): directly related wit the cost field, in case its specified this represents if that cost is for the entire group (total) or if the cost is per lead (cpl),

group_type (Enum): Can be static or smart depending if the group is static snapshot list of elements (added manually), or a list of filters to apply a s a live query to get the elements

element_type (Enum): Can be one of the following "Individuals", "Organizations" or "Deals" depending on the type of items to be inserted into this group

id (string): unique identifier for this group,

owner_id (string): unique id from the SalesSeek user who is the owner of this group (by default the creator)

name (int): group name to be shown,

permision (Array): ???,

columns (Array): Array of columns to be shown,

filter_id (string): unique ID for the set of filters applyed,

rules(Array(RuleSet)): list of different RuleSets, if more than one on this Array an AND clause will be applied between all RuleSets belonging to this Array

}

 RuleSet(Array(Rule)): Set of rules for querying, if more than one and OR clause is applied to this current RuleSet,

 

Rule(JSON) {

field(string): Any field name indirectly related to individuals ( any from individual, organization, opportunity, communications, etc),

operator(Enum): one of the following values: contains, equal, empty, starts_with, ends_with,within_last, more_than,

value(values): might be a String for the value of this field, or a new JSON if the operator is related to a timestamp,

not(boolean): true for applying a negation over the current rule, false or empty otherwise

}

values(JSON) {

value(string): value asigned by the user,

unit(string): depending on the timestamp unit this might be h, d, m or y for those rules based on a relative time ago

}

 

{
  cost: 200,
  comments: "All users from California",
  cost_basis: "total",
  id: "a3451f5",
  name: "Users with phone starting in 
  +44 AND (name containing "x" or created < 24h ago)",
  permissions: [
    0: "salesseek.core.all_permissions"
    1: "salesseek.core.edit",
    2: "salesseek.core.view"
  ]
  short_id: "a3451f5",
  type: "smart_group",
  rules [
    0: [
      0: {
        field: "communication_value"
        operator: "starts_with"
        values: "+44"
      }
    ],
    1: [
      0: {
        field: "individual_created"
        operator: "within_last"
        values: {
          value:24,
          unit: h
        }
      }
      1: {
        field: "individual_name",
        operator: "contains",
        values: "x",
        not: true
      }
    ]
  ]
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 smart_group _idInYThe id of the  smart group  to be updatedRequest Pathstring
 smart_group InYThe subset of the  smart group  model fields to be updatedRequest BodyJSON
 smart_group OutThe  smart group  after the successful updateResponse BodyJSON

 


 

DELETE /smart_groups/{smart_group _id}

Deletes a specific smart group by its ID

Deletes a specific smart_group by its {smart_group _id}

Request URL

https://aptui.salesseek.info/api/smart_groups/a3451f5  

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 smart_group _idInYThe id of the smart group to be deletedRequest Pathstring

 


 

Get /smart_groups/{group_id}/individuals

Provides the list of individuals belonging to this smart group  

Provides the list of individuals belonging to this smart_group    

Request URL

https://aptui.salesseek.info/api/smart_groups/69d1f4ae62/individuals?start=0&rows=10

Response Type

Response content type: JSON Array[individual]

ModelExample of Response
Array[individual]

Individual  {

comments(string): Specific text field for general information about this individual,

communication(Array[Communication]): The list of ways to communicate with this individual, including email, phone, LinkedIn, Facebook, Twitter and GooglePlus,

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

first_name(string): Individual first name,

id(string): unique identifier for this individual,

is_favorite(boolean): true or false if this individual is favorite for the current SalesSeek User (false by default),

locations(Array[Location]): List of addresses associated to this individual,

last_name(string): Individual last name,

modified(string): individual latest modification date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

organization_name(string): Organization Name this individual belongs to,

owner_id(string): ID for the SalesSeek User who owns this individual,

photo_url(string): entire url for an image assigned to this individual,

short_id(string): alias: shorter but still unique identifier for this individual,

source(Source): Lead source of this individual if defined,

source_id(string): Lead Source ID for this individual, if defined,

type(string): "individuals",

permissions(Array[string]): [

0: "salesseek.core.all_permissions"

1: "salesseek.core.edit"

2: "salesseek.core.view"

],

custom_fields(Associative Array): {

CustomFieldId1(String): CustomFieldValue1(String),

CustomFieldId2(String): CustomFieldValue2(String),

...

}

}

Source(JSON): {

id(string): Lead Source ID for this individual, if defined,

name(string): Text name of the lead source associated to tis individual, if defined,

}

Location  {

comments(string):Additional information related to the location, eg: working hours,

name(string): Text identifier for this location, eg: Home, Work, etc,

id (string): unique identifier for this location,

address(string): Complete Address

 }

Communication(JSON) {

id(string): unique identifier for the communication,

comments(string): text with the comments of this communication,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}


[
  0:{
    id: "6b169999",
    is_favorite: false,
    first_name: "Min",
    last_name: "Rome",
    comments: "Interested in developing new business in EMEA",
    created: "2014-01-15T19:36:56.597910",
    modified: "2014-01-15T19:36:56.597910",
    type: "individuals",
    custom_fields: {},
    locations: [
        0:{
            address: "20 Lake Road, London",
            name: "Work",
            organization_id: 8d6455af0c6
        }
    ]
    permissions: [
        0: "salesseek.core.all_permissions",
        1: "salesseek.core.edit",
        2: "salesseek.core.view",
    ]
    organization_id: "8d6455af0c6",
    organization_name: "LiveImp",
    photo_url: "http://creativepool.com/marketing/images/minions-1.jpg",
    roles: [
        0: {
            title:CMO,
            organization_id:8d6455af0c6
        }
    }
    source: {
        cost: 0,
        cost_basis: "total",
        default_owner: null,
        id: "5a8a23be-e6d4-43d9-849b-2d800b1c8d47",
        name: "Twitter",
        owner_id: null,
        short_id: "5a8a23be-e6d4-43d9-849b-2d800b1c8d47",
        system_type: "twitter",
        type: "lead_sources"
    }
    communication: [
        0:{
            name:Work,
            medium:phone,
            value:+155448855,
            comments:from 8:00 to 17:00
        }
        1: {
            name:Work,
            medium:email,
            value:minion@gmail.com,
            comments:From Mon to Sat
        }
        2: {
            medium:social,
            name:linkedin,
            value:https://www.linkedin.com/in/minrome/en
        }
        3: {
            medium:social,
            name:twitter,
            value:https://twitter.com/SalesSeek
        }
        4: {
            medium:social,
            name:facebook,
            value:https://www.facebook.com/SalesSeek?fref=ts
        }
        5: {
            medium:social,
            name:googleplus,
            value:https://plus.google.com/u/1/109741422344567872838/posts
        }
  }
,
  1:{....}
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Records-RowsOut-

Amount of records returned in this search

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