Retrieve a list of lead scoring models
get
/api/bulk/2.0/contacts/scoring/models
Retrieves a list of lead scoring models. Lead scoring fields are read only and can only be used in Contact Exports.
Request
Supported Media Types
- application/json
- text/csv
Query Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : LeadScoreModelSearchResponse
Type:
object
Title:
Show Source
LeadScoreModelSearchResponse
-
count:
integer
Title:
count
-
hasMore:
boolean
Title:
hasMore
-
items:
array items
Title:
items
-
limit:
integer
Title:
limit
-
offset:
integer
Title:
offset
-
totalResults:
integer(int64)
Title:
totalResults
Nested Schema : items
Type:
array
Title:
Show Source
items
-
Array of:
object LeadScoreModel
Title:
LeadScoreModel
Nested Schema : LeadScoreModel
Type:
object
Title:
Show Source
LeadScoreModel
-
createdAt:
string(date-time)
Title:
createdAt
-
createdBy:
string
Title:
createdBy
-
fields:
array fields
Title:
fields
-
id:
integer
Title:
id
-
name:
string
Title:
name
-
status:
string
Title:
status
-
updatedAt:
string(date-time)
Title:
updatedAt
-
updatedBy:
string
Title:
updatedBy
-
uri:
string
Title:
uri
Nested Schema : fields
Type:
array
Title:
Show Source
fields
-
Array of:
object StandardLeadScoringModelField
Title:
StandardLeadScoringModelField
Nested Schema : StandardLeadScoringModelField
Type:
object
Title:
Show Source
StandardLeadScoringModelField
-
dataType:
string
Title:
DataType
Default Value:number
Allowed Values:[ "number", "string", "boolean", "date", "emailAddress" ]
-
defaultValue:
string
Title:
defaultValue
-
hasNotNullConstraint:
boolean
Title:
hasNotNullConstraint
-
hasReadOnlyConstraint:
boolean
Title:
hasReadOnlyConstraint
-
hasUniquenessConstraint:
boolean
Title:
hasUniquenessConstraint
-
internalName:
string
Title:
internalName
-
name:
string
Title:
name
-
statement:
string
Title:
statement
-
uri:
string
Title:
uri
400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
409 Response
There was a conflict. See Status Codes for information about other possible HTTP status codes.
410 Response
The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.
412 Response
The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.
413 Response
Storage space exceeded. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.
503 Response
There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.
Examples
Retrieve a list of the first 5 lead scoring models:
GET /contacts/scoring/models?limit=5
Response:
{
"items":[
{
"name":"A Lead Scoring Model",
"status":"Draft",
"id":1,
"fields":[
{
"name":"Rating",
"statement":"{{Contact.LeadScore.Model[1].Rating}}",
"dataType":"string"
},
{
"name":"ProfileScore",
"statement":"{{Contact.LeadScore.Model[1].ProfileScore}}",
"dataType":"number"
},
{
"name":"EngagementScore",
"statement":"{{Contact.LeadScore.Model[1].EngagementScore}}",
"dataType":"number"
}
],
"uri":"/contacts/scoring/models/1",
"createdBy":"Api.User",
"updatedBy":"Api.User",
"createdAt":"2016-01-20T18:36:36.7570000Z",
"updatedAt":"2016-01-20T18:36:47.5800000Z"
},
{
"name":"Another Lead Scoring Model",
"status":"Active",
"id":2,
"fields":[
{
"name":"Rating",
"statement":"{{Contact.LeadScore.Model[2].Rating}}",
"dataType":"string"
},
{
"name":"ProfileScore",
"statement":"{{Contact.LeadScore.Model[2].ProfileScore}}",
"dataType":"number"
},
{
"name":"EngagementScore",
"statement":"{{Contact.LeadScore.Model[2].EngagementScore}}",
"dataType":"number"
}
],
"uri":"/contacts/scoring/models/2",
"createdBy":"Api.User",
"updatedBy":"Api.User",
"createdAt":"2016-01-20T19:58:23.9900000Z",
"updatedAt":"2016-01-21T16:09:28.9000000Z"
}
],
"totalResults":2,
"limit":5,
"offset":0,
"count":2,
"hasMore":false
}