Jump to

• Request
• Response
• Examples

Retrieve a lead scoring model

get

/api/bulk/2.0/contacts/scoring/models/{id}

using the lead scoring ID.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id(required): integer

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : LeadScoreModelIndividualResponse

Type: object

Title: LeadScoreModelIndividualResponse

Show Source

• 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

{
    "title":"LeadScoreModelIndividualResponse",
    "description":"",
    "properties":{
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "fields":{
            "title":"fields",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/StandardLeadScoringModelField"
            }
        },
        "id":{
            "title":"id",
            "description":"",
            "type":"integer"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "status":{
            "title":"status",
            "description":"",
            "type":"string"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: array

Title: fields

Show Source

• Array of: object StandardLeadScoringModelField
  Title: StandardLeadScoringModelField

{
    "title":"fields",
    "description":"",
    "type":"array",
    "items":{
        "$ref":"#/definitions/StandardLeadScoringModelField"
    }
}

Nested Schema : StandardLeadScoringModelField

Type: object

Title: StandardLeadScoringModelField

Show Source

• 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

{
    "title":"StandardLeadScoringModelField",
    "description":"",
    "properties":{
        "dataType":{
            "$ref":"#/definitions/DataType"
        },
        "defaultValue":{
            "title":"defaultValue",
            "description":"",
            "type":"string"
        },
        "hasNotNullConstraint":{
            "title":"hasNotNullConstraint",
            "description":"",
            "type":"boolean"
        },
        "hasReadOnlyConstraint":{
            "title":"hasReadOnlyConstraint",
            "description":"",
            "type":"boolean"
        },
        "hasUniquenessConstraint":{
            "title":"hasUniquenessConstraint",
            "description":"",
            "type":"boolean"
        },
        "internalName":{
            "title":"internalName",
            "description":"",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "statement":{
            "title":"statement",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

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.

Back to Top

Examples

Retrieve the lead scoring model with id #1:

GET /contacts/scoring/models/1
			

Response:

{
   "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"
}
			

Back to Top