---
title: "イベントAPI参照およびデータモデル"
slug: "events-api-reference-and-data-model"
abstract: "イベントAPIの参考情報はどこで見つけられるかSitecore Search。"
---
# イベントAPI参照およびデータモデル

Events APIを扱う際は、すべてのオブジェクトやキーの詳細なデータモデルや記述については[APIリファレン](https://doc.sitecore.com/search/en/developers/events-api/index.html) スを参照してください。

特定のイベントで必要なキーやオブジェクトの詳細については、それらのイベントを参照してください。例えば、対応する必要なキーについては [「ブックマーク追加イベント](https://doc.sitecore.com/search/ja/developers/search-developer-guide/integrating-using-rest-apis/using-the-events-api-to-track-events/funnel-events/creating-a-bookmark-add-event.html "Creating a bookmark add event")の作成」「ウィ [ジェットビューイベントの作成](https://doc.sitecore.com/search/ja/developers/search-developer-guide/integrating-using-rest-apis/using-the-events-api-to-track-events/widget-events/creating-a-widget-view-event.html "Creating a widget view event")」「ウィ [ジェットの表示](https://doc.sitecore.com/search/ja/developers/search-developer-guide/integrating-using-rest-apis/using-the-events-api-to-track-events/widget-events/creating-a-widget-click-event.html "Creating a widget click event") イベントの作成」などを参照してください。

以下はAPIリクエストのサンプルデータモデルです:

> !注このサンプルに示されているすべてのキーがすべてのイベントオブジェクトで必要なわけではありません。各イベントに必要なキーについては、それぞれのイベントを参照してください。

{
 "action": "<event action>",
 "action\_sub\_type": "<event action subtype>",
 "client\_time\_ms": 1660088972963,
 "interaction\_id": "<identifier to group visitor's interactions>",
 "name": "<event name>",
 "page\_load\_time\_ms": 1660088972963,
 "request\_id": "<identifier of search request>",
 "user\_id": "<unique ID of visitor>",
 "uuid": "<unique ID of visitor>",
 "value": {
 "context": {
 "browser": {
 "app\_type": "browser",
 "device": "mobile",
 "user\_agent": "Mozilla/5.0 (iPhone14,6; U; CPU iPhone OS 15\_4 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) Version/10.0 Mobile/19E241 Safari/602.1"
 },
 "geo": {
 "city": "San Francisco",
 "country": "us",
 "ip": "207.242.49.4",
 "state": "CA",
 "zip": "94403"
 },
 "page": {
 "locale\_country": "us",
 "locale\_currency": "usd",
 "locale\_language": "en",
 "referrer": "<URL of the referring page>",
 "title": "<Title of the current page>",
 "uri": "<URL of the current page>"
 },
 "user": {
 "addn\_attributes": "<Custom map of user attributes>",
 "address": {
 "address\_line\_1": "9090 Main Street",
 "address\_line\_2": "Unit 204",
 "country": "US",
 "state": "CA",
 "zip": "94403"
 },
 "cuid": "<Permanent user ID in your system>",
 "eid": "<Opaque ID that represents the user's email ID>",
 "email": "test@gmail.com",
 "fbid": "<Facebook ID of the user>",
 "gender": "male",
 "segments": "user\_group\_1", "user\_group\_2"...
 }
 },
 "entities": 
 {
 "attributes": {
 "author": "<Author of entity>"
 },
 "entity\_subtype": "article/blog",
 "entity\_type": "content, product",
 "id": "<External unique identifier for the entity>",
 "uri": "<URI of the entity>"
 }
 ,
 "filters": 
 {
 "display\_name": 
 "<Display name>"
 ,
 "end\_value": "<string>",
 "facet\_position": "<string>",
 "field": "<string>",
 "name": "<string>",
 "start\_value": "<string>",
 "title": "<string>",
 "value": 
 "<string>"
 ,
 "value\_position": 
 0
 
 }
 ,
 "index": 0,
 "request": {
 "advanced\_query\_text": "<Query text>",
 "keyword": "<Keyword>",
 "modified\_keyword": "<Modified keyword>",
 "num\_requested": 0,
 "num\_results": 0,
 "page\_number": 0,
 "page\_size": 0,
 "redirect\_url": "<Redirect URL>",
 "total\_results": 0,
 }
 "review": {
 "comment": "<Comment text>",
 "id": "<Review ID>",
 "rating": 1
 },
 "rfkid": "<widget ID>",
 "transaction": {
 "coupon": "string",
 "order\_id": "string",
 "order\_subtotal": 0,
 "order\_total": 0
 }
 }
 }