Jump to

• Request
• Response

Get facts about the activity effectiveness

get

/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/facts/activityEffectiveness

This method is used to get the record level facts about the activity effectiveness of a record.

Request

Query Parameters

• q: string
  To identify: A CRM object record by ObjectType and ObjectId values. Example: ObjectType=lead;ObjectId=999999999

There's no request body for this operation.

Security

• BasicAuthentication: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Headers

• Server-Time-In-Millis:
  The server time comnsumed by the API to complete execution.

Body ()

Root Schema : ActivityEffectivenessFacts

Type: object

Title: ActivityEffectivenessFacts

The activityEffectiveness API response.

Show Source

• count: integer
  The count of items in current response.
• hasMore: boolean
  A boolean flag which indicates the availability of more matching records at server.
• items: array items
  The activity effectiveness facts array.
• limit: integer
  The limit applied to the query.
• links: array links
  The links.
• offset: integer
  The offset applied to the query.

{
    "title":"ActivityEffectivenessFacts",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The activity effectiveness facts array.",
            "items":{
                "$ref":"#/components/schemas/ActivityEffectivenessFactItems"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset applied to the query."
        },
        "limit":{
            "type":"integer",
            "description":"The limit applied to the query."
        },
        "hasMore":{
            "type":"boolean",
            "description":"A boolean flag which indicates the availability of more matching records at server."
        },
        "count":{
            "type":"integer",
            "description":"The count of items in current response."
        },
        "links":{
            "type":"array",
            "description":"The links.",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "description":"The activityEffectiveness API response."
}

Nested Schema : items

Type: array

The activity effectiveness facts array.

Show Source

• Array of: object ActivityEffectivenessFactItems
  Title: ActivityEffectivenessFactItems

  The facts about the activity effectiveness of a record generated using the object and record level metrics.

{
    "type":"array",
    "description":"The activity effectiveness facts array.",
    "items":{
        "$ref":"#/components/schemas/ActivityEffectivenessFactItems"
    }
}

Nested Schema : links

Type: array

The links.

Show Source

• Array of: object Link
  Title: Link

  The link item.

{
    "type":"array",
    "description":"The links.",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : ActivityEffectivenessFactItems

Type: object

Title: ActivityEffectivenessFactItems

The facts about the activity effectiveness of a record generated using the object and record level metrics.

Show Source

• CreatedBy: string
  Indicates the user who created the row.
• CreationDate: string (date-time)
  Indicates the date and time of the creation of the row.
• ExplanationText: string
  The explanation for the record classification .
• InsightFactId: integer
  The auto-generated unique identifier for an insight fact.
• InsightTemplateUuid: string (uuid)
  The auto-generated unique Identifier for an insight template
• InsightTypeCode: string
  A unique code assigned to an insight template.
• LastUpdateDate: string (date-time)
  Indicates the date and time of the last update of the row.
• LastUpdatedBy: string
  Indicates the user who last updated the row.
• LastUpdateLogin: string
  Indicates the session login associated to the user who last updated the row.
• ObjectId: integer
  The PK attribute value of the CRM record
• ObjectType: string
  The object type name of the CRM entity.
• RecordClassification: string
  The classification text of the record based on the facts generated.
• RecordClassificationCode: string
  The classification code of the record based on the facts generated.
• RecordFacts: array RecordFacts
  The record level facts generated by comparing record query result against object metrics.

{
    "title":"ActivityEffectivenessFactItems",
    "type":"object",
    "properties":{
        "InsightFactId":{
            "type":"integer",
            "description":"The auto-generated unique identifier for an insight fact."
        },
        "InsightTypeCode":{
            "type":"string",
            "description":"A unique code assigned to an insight template."
        },
        "LastUpdatedBy":{
            "type":"string",
            "description":"Indicates the user who last updated the row."
        },
        "LastUpdateLogin":{
            "type":"string",
            "description":"Indicates the session login associated to the user who last updated the row."
        },
        "InsightTemplateUuid":{
            "type":"string",
            "description":"The auto-generated unique Identifier for an insight template",
            "format":"uuid"
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date and time of the creation of the row.",
            "format":"date-time"
        },
        "RecordClassificationCode":{
            "type":"string",
            "description":"The classification code of the record based on the facts generated."
        },
        "RecordClassification":{
            "type":"string",
            "description":"The classification text of the record based on the facts generated."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time"
        },
        "ExplanationText":{
            "type":"string",
            "description":"The explanation for the record classification ."
        },
        "CreatedBy":{
            "type":"string",
            "description":"Indicates the user who created the row."
        },
        "RecordFacts":{
            "type":"array",
            "description":"The record level facts generated by comparing record query result against object metrics.",
            "items":{
                "$ref":"#/components/schemas/ActivityEffectivenessFact"
            }
        },
        "ObjectId":{
            "type":"integer",
            "description":"The PK attribute value of the CRM record"
        },
        "ObjectType":{
            "type":"string",
            "description":"The object type name of the CRM entity."
        }
    },
    "description":"The facts about the activity effectiveness of a record generated using the object and record level metrics."
}

Nested Schema : RecordFacts

Type: array

The record level facts generated by comparing record query result against object metrics.

Show Source

• Array of: object ActivityEffectivenessFact
  Title: ActivityEffectivenessFact

  The fact data about the activity effectiveness.

{
    "type":"array",
    "description":"The record level facts generated by comparing record query result against object metrics.",
    "items":{
        "$ref":"#/components/schemas/ActivityEffectivenessFact"
    }
}

Nested Schema : ActivityEffectivenessFact

Type: object

Title: ActivityEffectivenessFact

The fact data about the activity effectiveness.

Show Source

• CurrentSalesStage: string
  The id of the current sales stage (if the object type is opportunity)
• InsightSubTypeCode: string
  The insight sub type code.
• ObjectAverage: string
  The object level average.
• RecordAge: string
  The age of the record.
• StatusCode: string
  The status code (if the object type is lead)
• TotalCount: string
  The total count of the records matching the query.

{
    "title":"ActivityEffectivenessFact",
    "type":"object",
    "properties":{
        "TotalCount":{
            "type":"string",
            "description":"The total count of the records matching the query."
        },
        "StatusCode":{
            "type":"string",
            "description":"The status code (if the object type is lead)"
        },
        "CurrentSalesStage":{
            "type":"string",
            "description":"The id of the current sales stage (if the object type is opportunity)"
        },
        "InsightSubTypeCode":{
            "type":"string",
            "description":"The insight sub type code."
        },
        "ObjectAverage":{
            "type":"string",
            "description":"The object level average."
        },
        "RecordAge":{
            "type":"string",
            "description":"The age of the record."
        }
    },
    "description":"The fact data about the activity effectiveness."
}

Nested Schema : Link

Type: object

Title: Link

The link item.

Show Source

• href: string
  The link href.
• kind: string
  The link kind.
• name: string
  The link name.
• rel: string
  The link relation.

{
    "title":"Link",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The link name."
        },
        "kind":{
            "type":"string",
            "description":"The link kind."
        },
        "href":{
            "type":"string",
            "description":"The link href."
        },
        "rel":{
            "type":"string",
            "description":"The link relation."
        }
    },
    "description":"The link item."
}

400 Response

Bad Request

401 Response

Unauthorized

404 Response

Not Found

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top