SaaSus Analysis API Schema (1.0.0)

SaaSus Analysis API Schema

userAnalysis

ユーザの行動分析

当日のユーザ行動履歴を更新

当日のユーザ行動履歴を更新します。

Authorizations:

Bearer

Request Body schema: application/json

timestamp required	integer (更新対象日) 更新対象日
user_id required	string (Uuid)
required	Array of objects (UserBehaviorHistory) ユーザの行動履歴一覧

Responses

Request samples

Payload

Content type

application/json

{"timestamp": 1640995200,
"user_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
"histories": [{"timestamp": 1640995200,
"referer": "https://examaple.com/examaple"
}
]
}

Response samples

500

Content type

application/json

{"type": "permission_denied",
"message": "エラーメッセージ"
}

過去1ヶ月のユーザ行動履歴を取得します

Authorizations:

Bearer

path Parameters

user_id

required

string

Example: f94bfffc-8be2-11ec-b41a-0242ac120004

ユーザーID

Responses

Response samples

200
500

Content type

application/json

{"histories": [{"behaved_at": 1640995200,
"histories": [{"timestamp": 1640995200,
"referer": "https://examaple.com/examaple"
}
]
}
]
}

metrics

メトリクス分析

集計されたメトリクスを取得

メトリクスタイプと期間を指定して集計されたメトリクスを取得します。

Authorizations:

Bearer

query Parameters

metrics_type required	string Enum: "create_tenant" "create_saas_user" "create_tenant_user" Example: metrics_type=create_tenant メトリクスタイプ
start_date required	string Example: start_date=2025-01-01 開始日（YYYY-MM-DD）
end_date required	string Example: end_date=2025-01-31 終了日（YYYY-MM-DD）
tenant_ids	Array of strings Example: tenant_ids=f94bfffc-8be2-11ec-b41a-0242ac120004 テナントID

Responses

Response samples

200
400
500

Content type

application/json

{"metrics": [{"date": "2025-01-01",
"count": 100,
"details": {"19045586-d4b0-418a-8e51-b6346380cd63": 40,
"fa3018b1-1be3-49ca-9ea7-d6d657d0f878": 60
}
}
]
}

ページ統計情報を取得

指定された期間のページ統計情報を取得します。

Authorizations:

Bearer

query Parameters

start_timestamp required	integer Example: start_timestamp=1701388800 Start timestamp of statistics period (UNIX timestamp)
end_timestamp required	integer Example: end_timestamp=1704067199 End timestamp of statistics period (UNIX timestamp)

Responses

Response samples

200
500

Content type

application/json

{"start_date": 1701388800,
"end_date": 1704067199,
"total_page_views": 15420,
"total_unique_users": 1234,
"page_statistics": [{"page_url": "https://example.com/dashboard",
"total_views": 3450,
"unique_users": 856
}
]
}

テナント別のGetUserInfo実行数を取得

期間とテナントIDを指定してGetUserInfo APIの日別実行数を取得します。

Authorizations:

Bearer

query Parameters

start_date required	string Example: start_date=2025-01-01 開始日（YYYY-MM-DD）
end_date required	string Example: end_date=2025-01-31 終了日（YYYY-MM-DD）
tenant_ids	Array of strings Example: tenant_ids=f94bfffc-8be2-11ec-b41a-0242ac120004 テナントID

Responses

Response samples

200
400
500

Content type

application/json

{"metrics": [{"date": "2025-01-01",
"details": {"00000000-0000-0000-0000-000000000000": 1460,
"0d7de8a8-1234-5678-9abc-def012345678": 1040,
"252a9f83-1234-5678-9abc-def012345678": 930
}
}
]
}