Analysis API

• userAnalysis
  • put当日のユーザ行動履歴を更新
  • get過去1ヶ月のユーザ行動履歴を取得します
  • get日次または月次のアクティブユーザー数を取得
  • putアクティブユーザーデータの追加・更新
• metrics
  • get集計されたメトリクスを取得
  • getページ統計情報を取得
  • getテナント別のGetUserInfo実行数を取得

API docs by Redocly

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

Production API Server

https://api.saasus.io/v1/analysis/user-behavior-day

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ヶ月のユーザ行動履歴を取得します

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

Authorizations:

Bearer

path Parameters

user_id required

string Example: f94bfffc-8be2-11ec-b41a-0242ac120004 ユーザーID

Responses

Production API Server

https://api.saasus.io/v1/analysis/users/{user_id}/behavior-histories

Response samples

• 200
• 500

Content type

application/json

{

• "histories": [

  • {

    • "behaved_at": 1640995200,
    • "histories": [

      • {

        • "timestamp": 1640995200,
        • "referer": "https://examaple.com/examaple"

        }

      ]

    }

  ]

}

日次または月次のアクティブユーザー数を取得

日次または月次のアクティブユーザー数を取得します。

Authorizations:

Bearer

query Parameters

type required	string Enum: "monthly" "daily" アクティブユーザーデータのタイプ（月次または日次）
date_from required	string Example: date_from=2025-01 開始日（月次の場合はYYYY-MM、日次の場合はYYYY-MM-DD）
date_to	string Example: date_to=2025-12 終了日（月次の場合はYYYY-MM、日次の場合はYYYY-MM-DD）。任意。
tenant_id	string (Uuid) Example: tenant_id=69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID（任意）
env_id	integer (Id) Example: env_id=1 環境ID（任意、tenant_idが必要）

Responses

Production API Server

https://api.saasus.io/v1/analysis/active-users

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "data": [

  • {

    • "date": "2025-01",
    • "tenant_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "env_id": 1,
    • "active_users": 100

    }

  ]

}

アクティブユーザーデータの追加・更新

日次または月次のアクティブユーザーデータを追加・更新します。

Authorizations:

Bearer

Request Body schema: application/json

required

type required	string (タイプ) Enum: "daily" "monthly" アクティブユーザーデータのタイプ（月次または日次）
date required	string (日付) 日付（月次の場合はYYYY-MM、日次の場合はYYYY-MM-DD）
tenant_id required	string (Uuid)
env_id required	integer (Id)
active_users required	integer (アクティブユーザー数) アクティブユーザー数

Responses

Production API Server

https://api.saasus.io/v1/analysis/active-users

Request samples

• Payload

Content type

application/json

{

• "type": "daily",
• "date": "2025-01-01",
• "tenant_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "env_id": 1,
• "active_users": 100

}

Response samples

• 400
• 500

Content type

application/json

{

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

}

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

Production API Server

https://api.saasus.io/v1/analysis/metrics/aggregated

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

Production API Server

https://api.saasus.io/v1/analysis/metrics/page-statistics

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

Production API Server

https://api.saasus.io/v1/analysis/userinfo/aggregated

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

      }

    }

  ]

}