機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

エンゲージメント・レベルに関するファクトの取得

get

/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/facts/engagementLevel

このメソッドは、レコードのエンゲージメント・レベルに関するレコード・レベルのファクトを取得します。

リクエスト

問合せパラメータ

• q(required): string
  識別: ObjectTypeおよびObjectId値によるCRMオブジェクト・レコード。 例: ObjectType=account;ObjectId=999999999

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

200 レスポンス

OK

ヘッダー

• Server-Time-In-Millis(required):
  実行を完了するためにAPIによって累積されたサーバー時間。

本文( )

ルート・スキーマ : EngagementLevelFacts

タイプ: object

タイトル: EngagementLevelFacts

engagementLevel APIレスポンス。

ソースを表示

• count: integer
  現在のレスポンスのアイテム数。
• hasMore: boolean
  サーバーで一致するレコードが多いことを示すブール・フラグ。
• items: array items
  エンゲージメント・レベルのファクト・アイテム。
• limit: integer
  問合せに適用される制限。
• links: array links
  リンク。
• offset: integer
  問合せに適用されるオフセット。

{
    "title":"EngagementLevelFacts",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The engagement level fact items.",
            "items":{
                "$ref":"#/components/schemas/EngagementLevelFactItems"
            }
        },
        "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 engagementLevel API response."
}

ネストされたスキーマ : アイテム

タイプ: array

エンゲージメント・レベルのファクト・アイテム。

ソースを表示

• Array of: object EngagementLevelFactItems
  タイトル: EngagementLevelFactItems

  オブジェクトおよびレコード・レベル・メトリックを使用して生成されたレコードのエンゲージメント・レベルに関するファクト。

{
    "type":"array",
    "description":"The engagement level fact items.",
    "items":{
        "$ref":"#/components/schemas/EngagementLevelFactItems"
    }
}

ネストされたスキーマ : リンク

タイプ: array

リンク。

ソースを表示

• Array of: object Link
  タイトル: Link

  リンク・アイテム。

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

ネストされたスキーマ : EngagementLevelFactItems

タイプ: object

タイトル: EngagementLevelFactItems

オブジェクトおよびレコード・レベル・メトリックを使用して生成されたレコードのエンゲージメント・レベルに関するファクト。

ソースを表示

• CreatedBy: string
  行の作成ユーザーを示します。
• CreationDate: string (date-time)
  行の作成日時を示します。
• ExplanationText: string
  レコード分類の説明。
• InsightFactId: integer
  インサイト・ファクトの自動生成された一意の識別子。
• InsightTemplateUuid: 文字列(uuid)
  インサイト・テンプレートの自動生成された一意の識別子
• InsightTypeCode: string
  インサイト・テンプレートに割り当てられた一意のコード。
• LastUpdateDate: string (date-time)
  行の最終更新日時を示します。
• LastUpdatedBy: string
  行の最終更新ユーザーを示します。
• LastUpdateLogin: string
  行を最後に更新したユーザーに関連付けられたセッション・ログインを示します。
• ObjectId: integer
  CRMレコードのPK属性値
• ObjectType: string
  CRMエンティティのオブジェクト・タイプ名。
• RecordClassification: string
  生成されたファクトに基づくレコードの分類テキスト。
• RecordClassificationCode: string
  生成されたファクトに基づくレコードの分類コード。
• RecordFacts: array RecordFacts
  レコード問合せ結果とオブジェクト・メトリックを比較して生成されるレコード・レベル・ファクト。

{
    "title":"EngagementLevelFactItems",
    "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/EngagementLevelFact"
            }
        },
        "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 engagement level of a record generated using the object and record level metrics."
}

ネストされたスキーマ : RecordFacts

タイプ: array

レコード問合せ結果とオブジェクト・メトリックを比較して生成されるレコード・レベル・ファクト。

ソースを表示

• Array of: object EngagementLevelFact
  タイトル: EngagementLevelFact

  エンゲージメント・レベルに関するファクト・データ。

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

ネストされたスキーマ : EngagementLevelFact

タイプ: object

タイトル: EngagementLevelFact

エンゲージメント・レベルに関するファクト・データ。

ソースを表示

• AccountName: string
  アカウント名。
• DaysSinceLastTouched: string
  最後にレコードに触れてからの日数。
• InsightSubTypeCode: string
  現在のインサイト・タイプのサブ・タイプである一意のコード。
• LastTouchedDateTime: string (date-time)
  取引先または取引先に関連するレコードが最後に更新された日時を示します。
• LastTouchedObjectId: string
  最後に触れたオブジェクトID。
• LastTouchedObjectType: string
  最後に触れたオブジェクト・タイプ。
• LastTouchedRecordName: string
  最後に触れたレコード名。
• LastTouchedRecordType: string
  最後に触れたレコードのタイプ。
• LastTouchedSourceObjectType: string
  最後に触れたソース・オブジェクト・タイプ。
• LastTouchedSourceRecordName: string
  最後に触れたソース・レコード名。
• SalesCycle: string
  販売サイクル値。
• TouchedRecordCount: string
  規定された時間枠内にユーザーが更新したレコードの数。

{
    "title":"EngagementLevelFact",
    "type":"object",
    "properties":{
        "AccountName":{
            "type":"string",
            "description":"The account name."
        },
        "DaysSinceLastTouched":{
            "type":"string",
            "description":"The days since last touched the record."
        },
        "LastTouchedSourceObjectType":{
            "type":"string",
            "description":"The last touched source object type."
        },
        "LastTouchedObjectId":{
            "type":"string",
            "description":"The last touched object ID."
        },
        "SalesCycle":{
            "type":"string",
            "description":"The sales cycle value."
        },
        "InsightSubTypeCode":{
            "type":"string",
            "description":"A unique code which is a sub type of the current insight type."
        },
        "TouchedRecordCount":{
            "type":"string",
            "description":"The number of records updated by the user within the stipulated time frame."
        },
        "LastTouchedDateTime":{
            "type":"string",
            "description":"Indicates when the account or a record related to the account was last updated.",
            "format":"date-time"
        },
        "LastTouchedObjectType":{
            "type":"string",
            "description":"The last touched object type."
        },
        "LastTouchedSourceRecordName":{
            "type":"string",
            "description":"The last touched source record name."
        },
        "LastTouchedRecordName":{
            "type":"string",
            "description":"The last touched record name."
        },
        "LastTouchedRecordType":{
            "type":"string",
            "description":"The last touched record type."
        }
    },
    "description":"The fact data about the engagement level."
}

ネストされたスキーマ : リンク

タイプ: object

タイトル: Link

リンク・アイテム。

ソースを表示

• href: string
  リンクhref。
• kind: string
  リンクの種類。
• name: string
  リンク名。
• rel: string
  リンク関係。

{
    "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 レスポンス

不正なリクエストです

401 レスポンス

承認されていません

404 レスポンス

Not Found

405 レスポンス

メソッドは許可されていません

500 レスポンス

内部サーバー・エラーです

「トップに戻る」