> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Get the search report > How the store was found in a search engine over a period: clicks, impressions, click rate and position, over time and by search, page, country and device. From an engine the store has connected in the dashboard. With none connected it is refused with `search_unavailable`. Neither engine has figures for today. Needs the `analytics.read` permission (Read Analytics). It is one of the heavier reads, and is counted against a smaller budget of its own: 60 a minute for each key. ## OpenAPI ````yaml /api-reference/openapi.json get /stores/{storeId}/analytics/search openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}/analytics/search: get: tags: - Analytics summary: Get the search report description: >- How the store was found in a search engine over a period: clicks, impressions, click rate and position, over time and by search, page, country and device. From an engine the store has connected in the dashboard. With none connected it is refused with `search_unavailable`. Neither engine has figures for today. Needs the `analytics.read` permission (Read Analytics). It is one of the heavier reads, and is counted against a smaller budget of its own: 60 a minute for each key. operationId: analytics.search parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string - name: provider in: query required: false description: Which engine. schema: type: string enum: - google - bing default: google - name: range in: query required: false description: The period. schema: type: string enum: - today - yesterday - 7d - 30d - this_week - last_week - this_month - last_month - this_year default: 30d - name: from in: query required: false description: >- The first day of a period of your own, as `YYYY-MM-DD`. With `to`, in place of `range`. schema: type: string - name: to in: query required: false description: Its last day, as `YYYY-MM-DD`. schema: type: string - name: tz in: query required: false description: The time zone those days are in, as an IANA name. Left out, UTC. schema: type: string example: Europe/Berlin - name: dimension in: query required: false description: 'To ask about one thing: what kind of thing `value` is.' schema: type: string enum: - query - page - country - device - name: value in: query required: false description: The one search, page, country or device to ask about. schema: type: string - name: find in: query required: false description: Only rows of one list that contain these words. schema: type: string - name: findIn in: query required: false description: Which list `find` narrows. schema: type: string enum: - query - page responses: '200': description: It worked. content: application/json: schema: $ref: '#/components/schemas/Envelope' '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.analytics.search(); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->analytics->search(); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.analytics.search() components: schemas: Envelope: type: object properties: success: type: boolean description: Whether the request did what was asked. message: type: - string - 'null' description: Words for a person. Empty when it worked. code: type: - string - 'null' description: >- Why it was refused, as a word that does not change. Empty when it worked. data: description: 'The thing asked for: an object, or for a list its rows.' pages: type: integer description: 'For a paged list: how many pages there are.' total: type: integer description: 'For a paged list: how many rows there are in all.' meta: type: object description: Anything else the route answers beside the thing itself. required: - success - message - code - data Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.