Jump to

• Request
• Response
• Examples

Retrieve a lead scoring model

get

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

Retrieve a lead scoring model using the lead scoring ID.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id(required): integer
  Id of the lead scoring model.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : LeadScoreModelIndividualResponse

Type: object

Title: LeadScoreModelIndividualResponse

The response body contains information about the lead score model definition.

Show Source

• createdAt: string(date-time)
  Title: createdAt

  The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
• createdBy: string
  Title: createdBy

  The login id of the user who created the entity. This is a read-only property.
• fields: array fields
  Title: fields

  List of fields to be included in the operation.
• id: integer
  Title: id

  The lead scoring model identifier.
• name: string
  Title: name

  The lead scoring model's name.
• status: string
  Title: status

  The status of the lead scoring model.
• updatedAt: string(date-time)
  Title: updatedAt

  The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
• updatedBy: string
  Title: updatedBy

  The login id of the user that last updated the entity. This is a read-only property.
• uri: string
  Title: uri

  System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

{
    "title":"LeadScoreModelIndividualResponse",
    "description":"The response body contains information about the lead score model definition.",
    "properties":{
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"The login id of the user who created the entity. This is a read-only property.",
            "type":"string"
        },
        "fields":{
            "title":"fields",
            "description":"List of fields to be included in the operation.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/StandardLeadScoringModelField"
            }
        },
        "id":{
            "title":"id",
            "description":"The lead scoring model identifier.",
            "type":"integer"
        },
        "name":{
            "title":"name",
            "description":"The lead scoring model's name.",
            "type":"string"
        },
        "status":{
            "title":"status",
            "description":"The status of the lead scoring model.",
            "type":"string"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"The login id of the user that last updated the entity. This is a read-only property.",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: array

Title: fields

List of fields to be included in the operation.

Show Source

• Array of: object StandardLeadScoringModelField
  Title: StandardLeadScoringModelField

  Standard Lead Score Model definition field

{
    "title":"fields",
    "description":"List of fields to be included in the operation.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/StandardLeadScoringModelField"
    }
}

Nested Schema : StandardLeadScoringModelField

Type: object

Title: StandardLeadScoringModelField

Standard Lead Score Model definition field

Show Source

• dataType: string
  Title: DataType

  Default Value: number

  Allowed Values: [ "number", "string", "boolean", "date", "emailAddress" ]

  The type of data, used for field definitions.
• defaultValue: string
  Title: defaultValue

  The field's default value.
• hasNotNullConstraint: boolean
  Title: hasNotNullConstraint

  Indicates whether the field can have null values (i.e. empty).
• hasReadOnlyConstraint: boolean
  Title: hasReadOnlyConstraint

  Indicates whether the field can be written to.
• hasUniquenessConstraint: boolean
  Title: hasUniquenessConstraint

  Indicates whether the field must have a unique value.
• internalName: string
  Title: internalName

  The field's internal name (used to uniquely identify it).
• name: string
  Title: name

  The asset's name.
• statement: string
  Title: statement

  The markup language statement used to reference the field in an import or export mapping.
• uri: string
  Title: uri

  System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

{
    "title":"StandardLeadScoringModelField",
    "description":"Standard Lead Score Model definition field",
    "properties":{
        "dataType":{
            "$ref":"#/definitions/DataType"
        },
        "defaultValue":{
            "title":"defaultValue",
            "description":"The field's default value.",
            "type":"string"
        },
        "hasNotNullConstraint":{
            "title":"hasNotNullConstraint",
            "description":"Indicates whether the field can have null values (i.e. empty).",
            "type":"boolean"
        },
        "hasReadOnlyConstraint":{
            "title":"hasReadOnlyConstraint",
            "description":"Indicates whether the field can be written to.",
            "type":"boolean"
        },
        "hasUniquenessConstraint":{
            "title":"hasUniquenessConstraint",
            "description":"Indicates whether the field must have a unique value.",
            "type":"boolean"
        },
        "internalName":{
            "title":"internalName",
            "description":"The field's internal name (used to uniquely identify it).",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"The asset's name.",
            "type":"string"
        },
        "statement":{
            "title":"statement",
            "description":"The markup language statement used to reference the field in an import or export mapping.",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
            "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