Developers
Help CenterCommunityStatus

Get a contact's scoring model scores - GetContactScores

Return a specific contact’s Acoustic Campaign scoring model values.

📘

Notes

Either CONTACT_ID or VISITOR_KEY must be passed for a valid response. If both are provided, the CONTACT_ID is used to look up the contact.

CONTACT_ID is the same as RECIPIENT_ID in other API calls.

Scoring models for a contact return based on the authenticated user's access.

If the contact is not scored and has null values in any of the returned Score Components, then the value is returned as . See "Example response: Contact with null values - XML".

Elements

CONTACT_ID - The ID of the contact you want the score values for.

VISITOR_KEY - The web tracking visitor key.

MODEL_ID - If specified, the method returns only the score values for the model. Otherwise, all scoring models return for the specified user.

<Envelope>
  <Body>
    <GetContactScores>
      <CONTACT_ID>3920341</CONTACT_ID>
    </GetContactScores>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
      <MODELS>
        <MODEL>
          <ID>5435</ID>
          <NAME>LeadStatusScoringModel</NAME>
          <SCORE_COMPONENTS>
            <SCORE_COMPONENT>
              <KEY>totalScore</KEY>
              <VALUE>15</VALUE>
            </SCORE_COMPONENT>
            <SCORE_COMPONENT>
              <KEY>behaviorScore</KEY>
              <VALUE>45</VALUE>
            </SCORE_COMPONENT>
            <SCORE_COMPONENT>
              <KEY>totalRank</KEY>
              <VALUE>Hot</VALUE>
            </SCORE_COMPONENT>
          </SCORE_COMPONENTS>
        </MODEL>
        <MODEL>
          <ID>5435</ID>
          <NAME>CustomerValueScoringModel</NAME>
          <DESC>This model is used to quality leads into SFDC promotions</DESC>
          <SCORE_COMPONENTS>
            <SCORE_COMPONENT>
              <KEY>totalScore</KEY>
              <VALUE>5</VALUE>
            </SCORE_COMPONENT>
            <SCORE_COMPONENT>
              <KEY>behaviorScore</KEY>
              <VALUE>0</VALUE>
            </SCORE_COMPONENT>
            <SCORE_COMPONENT>
              <KEY>totalRank</KEY>
              <VALUE>Low</VALUE>
            </SCORE_COMPONENT>
          </SCORE_COMPONENTS>
        </MODEL>
      </MODELS>
    </RESULT>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
      <MODELS>
        <MODEL>
          <ID>5435</ID>
          <NAME>LeadStatusScoringModel</NAME>
          <SCORE_COMPONENTS>
            <SCORE_COMPONENT>
              <KEY>totalScore</KEY>
              <VALUE/>
            </SCORE_COMPONENT>
            <SCORE_COMPONENT>
              <KEY>behaviorScore</KEY>
              <VALUE/>
            </SCORE_COMPONENT>
            <SCORE_COMPONENT>
              <KEY>totalRank</KEY>
              <VALUE/>
            </SCORE_COMPONENT>
          </SCORE_COMPONENTS>
        </MODEL>
      </MODELS>
    </RESULT>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>false</SUCCESS>
    </RESULT>
    <Fault>
      <Request/>
      <FaultCode/>
      <FaultString>Contact does not exist in the database or Contact List.</FaultString>
      <detail>
        <error>
          <errorid>133</errorid>
          <module/>
          <class>SP.API</class>
          <method/>
        </error>
      </detail>
    </Fault>
  </Body>
</Envelope>

Elements (Results)

SUCCESS - True if successful; False if not.

MODELS > MODEL - XML Node defining each of the Scoring Models containing the elements ID and NAME.
ID - A child of MODEL. The ID of the scoring model.
NAME - A child of MODEL. The name of the scoring model.

SCORE_COMPONENTS - A child of MODEL. The components (or sections) that define the scoring model. Contains SCORE_COMPONENT and its children.
SCORE_COMPONENT - XML Node defining each defined score component in the model: KEY and VALUE.
KEY - A child of SCORE_COMPONENT. The name of the score component.
VALUE - A child of SCORE_COMPONENT. The value/score of the score component.