機械翻訳について

ジャンプ先

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

オブジェクトのエンゲージメント・レベル・メトリックの取得

get

/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics/engagementLevel

このメソッドは、Salesオブジェクトのエンゲージメント・レベル・メトリックを取得します。

リクエスト

問合せパラメータ

• q(required): string
  識別: ObjectType値によるCRMオブジェクト。 例: ObjectType=opportunity

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

トップに戻る

応答

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

• application/json

200 レスポンス

OK

ヘッダー

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

本文( )

ルート・スキーマ : MetricsEngagementLevelResponse

タイプ: object

タイトル: MetricsEngagementLevelResponse

ソースを表示

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

{
    "title":"MetricsEngagementLevelResponse",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The engagement level metric items.",
            "items":{
                "$ref":"#/components/schemas/MetricItems"
            }
        },
        "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"
            }
        }
    }
}

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

タイプ: array

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

ソースを表示

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

  メトリック・アイテム。

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

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

タイプ: array

リンク。

ソースを表示

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

  リンク・アイテム。

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

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

タイプ: object

タイトル: metricItems

メトリック・アイテム。

ソースを表示

• CreatedBy: string
  行の作成ユーザーを示します。
• CreationDate: string (date-time)
  行の作成日時を示します。
• InsightMetricId: integer
  インサイト・メトリックの自動生成された一意の識別子。
• InsightTemplateUuid: 文字列(uuid)
  インサイト・テンプレートの自動生成された一意の識別子
• InsightTypeCode: string
  インサイト・テンプレートに割り当てられた一意のコード。
• LastUpdateDate: string (date-time)
  行の最終更新日時を示します。
• LastUpdatedBy: string
  行の最終更新ユーザーを示します。
• LastUpdateLogin: string
  行を最後に更新したユーザーに関連付けられたセッション・ログインを示します。
• ObjectMetrics: object ObjectMetrics
  オブジェクト問合せテンプレートの実行によって生成されるオブジェクト・レベル・メトリック。

{
    "title":"metricItems",
    "type":"object",
    "properties":{
        "InsightMetricId":{
            "type":"integer",
            "description":"The auto-generated unique Identifier for an insight metric."
        },
        "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"
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time"
        },
        "CreatedBy":{
            "type":"string",
            "description":"Indicates the user who created the row."
        },
        "ObjectMetrics":{
            "type":"object",
            "properties":{
            },
            "description":"The object level metrics generated by executing object query templates."
        }
    },
    "description":"The metric items."
}

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

タイプ: object

オブジェクト問合せテンプレートの実行によって生成されるオブジェクト・レベル・メトリック。

ソースを表示

{
    "type":"object",
    "properties":{
    },
    "description":"The object level metrics generated by executing object query templates."
}

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

タイプ: 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 レスポンス

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

「トップに戻る」