クエリ集検索

Prev Next
Post
/api/public/v1/cometa/queries/search

クエリ集を検索します。

Security
API Key: ApiKeyAuth
Header parameter nameAuthorization

認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
API KEYがabc123の場合は、Authorization: Token abc123とします。

Body parameters
object
q
string Required

検索クエリ文字列を指定します。

ExampleGMV
catalog_id
integer (int64)

検索対象を絞り込むデータストアIDを指定します。

Example17
review_status
string

レビュー状態による絞り込みを指定します。

Valid values[ "unverified", "approved" ]
Exampleapproved
page
integer

取得するページ番号を指定します。1始まり。

Default1
Example1
page_size
integer

1ページあたりの最大件数を指定します。

Minimum20
Maximum100
Default20
Example20
Responses
200

検索結果を返します。

Expand All
object
items
Array of object (cometa_query)
object
id
integer (int64)

クエリ集のIDです。

Example9001
title
string

クエリのタイトルです。

ExampleDaily GMV breakdown
description
string | null

クエリの説明です。

Example日次の注文金額を地域別に集計します。
sql
string

クエリ本文です。

ExampleSELECT date_trunc('day', ordered_at) AS day, region, SUM(amount) FROM orders GROUP BY 1, 2;
catalog_id
integer (int64) | null

関連付けられているデータストアのIDです。

Example17
author_email
string | null

クエリ作成者のメールアドレスです。作成者が削除済みの場合はnullを返します。

Exampleanalytics@example.com
updated_at
string

最終更新日時 (ISO8601 / UTC) です。

Example2026-04-10T12:34:56Z
pagination
object
current_page
integer

現在のページ番号です。1始まり。

Example1
page_size
integer

1ページあたりの最大件数です。

Example20
total_count
integer

検索条件にマッチした全件数です。

Example42
400

/api系の共通エラーレスポンス

object
message
string
Example不正なリクエストです。
401

認証エラー

object
message
string
Exampleアカウント登録もしくはログインしてください。
403

認可エラー

object
message
string
Example操作を実行する権限がありません。