PEpeec
Project

List Fanout Shopping Queries

Changed on

List the fanout shopping queries of a project

post/queries/shopping

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/queries/shopping
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Query parameters

project_idstring

Required if using a company api key

Example:or_f45b94ba-5e35-4982-93ed-285e72ee14eb

Request body

project_idstring

Required if using a company api key

limitinteger
offsetinteger
start_datestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

end_datestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Example request

{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "start_date": "2025-09-22",
  "end_date": "2025-09-22",
  "filters": [
    {
      "field": "prompt_id",
      "operator": "in",
      "values": [
        "pr_abc123"
      ]
    }
  ]
}

Response

Success

total_countnumber required

Total number of matching shopping queries, ignoring pagination

totalCountnumber required

Total number of matching shopping queries, ignoring pagination

Example response

{
  "data": [
    {
      "prompt": {
        "id": "pr_93f790de-5b7a-45ee-b782-61103c81f20d"
      },
      "chat": {
        "id": "ch_61184892-36ad-4e1a-8178-3a83608f7711"
      },
      "model": {
        "id": "gpt-4o-search"
      },
      "model_channel": {
        "id": "openai-1"
      },
      "date": "2025-09-17",
      "query": {
        "text": "What is Peec?",
        "products": [
          "Peec AI",
          "Peec Pro"
        ]
      }
    }
  ],
  "total_count": 42,
  "totalCount": 42
}

Changes

  • 9d774600c8ebRevision changes
    • breaking

      removed subschema #1 subschema #2 from the / request property anyOf list (media type: application/json)

    • breaking

      removed subschema #1 subschema #2 from the / request property anyOf list (media type: application/x-www-form-urlencoded)

    • breaking

      removed subschema #1 subschema #2 from the / request property anyOf list (media type: multipart/form-data)

    • info

      added subschema #1 subschema #2 to the / request property anyOf list (media type: application/json)

    • info

      added subschema #1 subschema #2 to the / request property anyOf list (media type: application/x-www-form-urlencoded)

    • info

      added subschema #1 subschema #2 to the / request property anyOf list (media type: multipart/form-data)

  • 9fdffdff48a5Revision changes
    • breaking

      removed subschema #1 subschema #2 subschema #3 from the / request property anyOf list (media type: application/json)

    • breaking

      removed subschema #1 subschema #2 subschema #3 from the / request property anyOf list (media type: application/x-www-form-urlencoded)

    • breaking

      removed subschema #1 subschema #2 subschema #3 from the / request property anyOf list (media type: multipart/form-data)

    • breaking

      the request property type changed from number to integer (media type: application/json)

    • breaking

      the request property type changed from number to integer (media type: application/x-www-form-urlencoded)

    • breaking

      the request property type changed from number to integer (media type: multipart/form-data)

    • breaking

      the request property type changed from number to integer (media type: application/json)

    • breaking

      the request property type changed from number to integer (media type: application/x-www-form-urlencoded)

    • breaking

      the request property type changed from number to integer (media type: multipart/form-data)

    • warning

      the request property's max was set to 9007199254740991.00 (media type: application/json)

    • warning

      the request property's max was set to 9007199254740991.00 (media type: application/x-www-form-urlencoded)

    • warning

      the request property's max was set to 9007199254740991.00 (media type: multipart/form-data)

    • info

      added subschema #1 subschema #2 subschema #3 to the / request property anyOf list (media type: application/json)

    • info

      added subschema #1 subschema #2 subschema #3 to the / request property anyOf list (media type: application/x-www-form-urlencoded)

    • info

      added subschema #1 subschema #2 subschema #3 to the / request property anyOf list (media type: multipart/form-data)