提示词表现表

Prompt table with per-prompt metrics (paginated)

curl --request POST \
  --url https://app.geoly.ai/api/v1/reports/prompts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 20,
  "cursor": "<string>",
  "search": "<string>",
  "sort_order": "desc",
  "time_range": "30d",
  "start_date": "<string>",
  "end_date": "<string>",
  "platform": "all",
  "topic_ids": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "status": "active",
  "country": "<string>",
  "include_competitors": false
}
'

import requests

url = "https://app.geoly.ai/api/v1/reports/prompts"

payload = {
    "limit": 20,
    "cursor": "<string>",
    "search": "<string>",
    "sort_order": "desc",
    "time_range": "30d",
    "start_date": "<string>",
    "end_date": "<string>",
    "platform": "all",
    "topic_ids": ["<string>"],
    "tags": ["<string>"],
    "status": "active",
    "country": "<string>",
    "include_competitors": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    limit: 20,
    cursor: '<string>',
    search: '<string>',
    sort_order: 'desc',
    time_range: '30d',
    start_date: '<string>',
    end_date: '<string>',
    platform: 'all',
    topic_ids: ['<string>'],
    tags: ['<string>'],
    status: 'active',
    country: '<string>',
    include_competitors: false
  })
};

fetch('https://app.geoly.ai/api/v1/reports/prompts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "prompts": [
      {
        "id": "<string>",
        "text": "<string>",
        "category": "<string>",
        "tags": [
          "<string>"
        ],
        "country": "<string>",
        "is_active": true,
        "topic_id": "<string>",
        "topic_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "is_branded": true,
        "in_flight_records": 1,
        "records": 1,
        "citations": 1,
        "brand_citation_records": 1,
        "platforms": [
          {
            "platform_code": "<string>",
            "position": 123,
            "mentions": 123,
            "status": "<string>",
            "record_date_at": "2023-11-07T05:31:56Z"
          }
        ],
        "performance": {
          "total_mentions": 1,
          "avg_position": 123,
          "has_top3": true,
          "has_top5": true,
          "has_top10": true
        },
        "geo_metrics": {
          "visibility_score": 50,
          "mention_rate_pct": 50,
          "citation_rate_pct": 50,
          "mentioned_records": 1,
          "completed_records": 1,
          "delta": {
            "visibility_score": 123,
            "avg_position": 123,
            "citation_rate_pp": 123,
            "share_pp": 123
          },
          "delta_insufficient": {
            "visibility_score": true
          }
        },
        "competitors_state": "deferred",
        "som": {
          "share_pct": 50,
          "rank": 1,
          "total_competitors": 1
        },
        "competitor_mentions": [
          {
            "name": "<string>",
            "mentioned_records": 1,
            "share_pct": 50,
            "domain": "<string>"
          }
        ]
      }
    ],
    "summary": {
      "visibility_score": 50,
      "mention_rate_pct": 50,
      "citation_rate_pct": 50,
      "delta": {
        "visibility_score": 123,
        "mention_rate_pp": 123,
        "citation_rate_pp": 123
      },
      "delta_insufficient": {
        "visibility_score": true,
        "mention_rate_pp": true,
        "citation_rate_pp": true
      }
    },
    "competitors_included": true,
    "country_options": [
      "<string>"
    ]
  },
  "page": {
    "next_cursor": "<string>",
    "limit": 123,
    "total": 123,
    "capped": true
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "schema_conformant": true,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

POST

api

reports

prompts

Prompt table with per-prompt metrics (paginated)

curl --request POST \
  --url https://app.geoly.ai/api/v1/reports/prompts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 20,
  "cursor": "<string>",
  "search": "<string>",
  "sort_order": "desc",
  "time_range": "30d",
  "start_date": "<string>",
  "end_date": "<string>",
  "platform": "all",
  "topic_ids": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "status": "active",
  "country": "<string>",
  "include_competitors": false
}
'

import requests

url = "https://app.geoly.ai/api/v1/reports/prompts"

payload = {
    "limit": 20,
    "cursor": "<string>",
    "search": "<string>",
    "sort_order": "desc",
    "time_range": "30d",
    "start_date": "<string>",
    "end_date": "<string>",
    "platform": "all",
    "topic_ids": ["<string>"],
    "tags": ["<string>"],
    "status": "active",
    "country": "<string>",
    "include_competitors": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    limit: 20,
    cursor: '<string>',
    search: '<string>',
    sort_order: 'desc',
    time_range: '30d',
    start_date: '<string>',
    end_date: '<string>',
    platform: 'all',
    topic_ids: ['<string>'],
    tags: ['<string>'],
    status: 'active',
    country: '<string>',
    include_competitors: false
  })
};

fetch('https://app.geoly.ai/api/v1/reports/prompts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "prompts": [
      {
        "id": "<string>",
        "text": "<string>",
        "category": "<string>",
        "tags": [
          "<string>"
        ],
        "country": "<string>",
        "is_active": true,
        "topic_id": "<string>",
        "topic_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "is_branded": true,
        "in_flight_records": 1,
        "records": 1,
        "citations": 1,
        "brand_citation_records": 1,
        "platforms": [
          {
            "platform_code": "<string>",
            "position": 123,
            "mentions": 123,
            "status": "<string>",
            "record_date_at": "2023-11-07T05:31:56Z"
          }
        ],
        "performance": {
          "total_mentions": 1,
          "avg_position": 123,
          "has_top3": true,
          "has_top5": true,
          "has_top10": true
        },
        "geo_metrics": {
          "visibility_score": 50,
          "mention_rate_pct": 50,
          "citation_rate_pct": 50,
          "mentioned_records": 1,
          "completed_records": 1,
          "delta": {
            "visibility_score": 123,
            "avg_position": 123,
            "citation_rate_pp": 123,
            "share_pp": 123
          },
          "delta_insufficient": {
            "visibility_score": true
          }
        },
        "competitors_state": "deferred",
        "som": {
          "share_pct": 50,
          "rank": 1,
          "total_competitors": 1
        },
        "competitor_mentions": [
          {
            "name": "<string>",
            "mentioned_records": 1,
            "share_pct": 50,
            "domain": "<string>"
          }
        ]
      }
    ],
    "summary": {
      "visibility_score": 50,
      "mention_rate_pct": 50,
      "citation_rate_pct": 50,
      "delta": {
        "visibility_score": 123,
        "mention_rate_pp": 123,
        "citation_rate_pp": 123
      },
      "delta_insufficient": {
        "visibility_score": true,
        "mention_rate_pp": true,
        "citation_rate_pp": true
      }
    },
    "competitors_included": true,
    "country_options": [
      "<string>"
    ]
  },
  "page": {
    "next_cursor": "<string>",
    "limit": 123,
    "total": 123,
    "capped": true
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "schema_conformant": true,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

{
  "error": {
    "code": "INVALID_BODY",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "report": "<string>",
    "duration_ms": 123,
    "quota": {
      "cost": 123,
      "unlimited": true,
      "remaining": 123,
      "resets_at": "2023-11-07T05:31:56Z",
      "charge": "charged",
      "min_fee_reason": "missing_locale"
    }
  }
}

授权

Authorization

string

header

必填

API key from Settings → Developer → API keys (prefix geom_). Each key is bound to one brand.

请求体

application/json

limit

integer

默认值:20

Rows per page (1–100).

必填范围: 1 <= x <= 100

cursor

string

Opaque cursor from page.next_cursor. Must be sent with exactly the same filters and limit.

Required string length: 1 - 512

string

Case-insensitive substring of the prompt text or a tag name.

Required string length: 1 - 200

sort_by

enum<string>

Sort key. Omit for the default: created_at for status=active, archived_at for status=archived.

可用选项:

text,

visibility,

mention_rate,

citations,

created_at,

archived_at

sort_order

enum<string>

默认值:desc

可用选项:

asc,

desc

time_range

enum<string>

默认值:30d

Metrics window. Ignored when start_date + end_date are given.

可用选项:

7d,

30d,

90d

start_date

string

Start of an exact metrics window; send together with end_date (UTC+8 business day, YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}-\d{2}$

end_date

string

End of an exact metrics window; send together with start_date (UTC+8 business day, YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}-\d{2}$

platform

enum<string>

默认值:all

AI platform, or "all".

可用选项:

all,

chatgpt,

perplexity,

gemini,

google_ai,

copilot,

google_ai_overview

topic_ids

string[]

Restrict to these topic ids (1–50). "_none" = prompts without a topic.

Required array length: 1 - 50 elements

Required string length: 1 - 64

响应

The prompts report. data follows PromptsReport when meta.schema_conformant is true.

data

object | null

必填

The prompts report. null only when meta.schema_conformant is false and the report output could not be mapped.

Show child attributes

page

object

必填

Cursor pagination. next_cursor === null is the only end-of-list signal.

Show child attributes

开始使用

账号

目录

监测记录

报表

授权

请求体

响应