> ## Documentation Index
> Fetch the complete documentation index at: https://docs.citino.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List attributes

> The attributes AI engines attach to the project's brand and to compared competitors, with each brand's strength and the gap between them in points, each brand's strength on eight fixed dimensions, and whose each attribute is. Only grouped attributes are listed.



## OpenAPI

````yaml /api-reference/openapi.json get /projects/{projectId}/attributes
openapi: 3.1.0
info:
  title: Citino API
  version: v1
  description: >-
    Read how AI engines answer your market's questions, and keep your prompts,
    competitors, segments and engines in step from code. Every number carries
    its band and sample size.
servers:
  - url: https://api.citino.ai/v1
security:
  - bearerAuth: []
tags:
  - name: Brand and competitors
  - name: Definitions
  - name: Engines
  - name: Projects
  - name: Alerts
  - name: Brand profile
  - name: Attribution
  - name: Claims
  - name: Crawlability
  - name: Crawler activity
  - name: Metrics
  - name: Experiments
  - name: Prompts
  - name: Objections
  - name: Products
  - name: Monthly reports
  - name: Reports
  - name: Runs
  - name: Searches
  - name: Sources
  - name: Work items
  - name: Settings
paths:
  /projects/{projectId}/attributes:
    get:
      tags:
        - Brand profile
      summary: List attributes
      description: >-
        The attributes AI engines attach to the project's brand and to compared
        competitors, with each brand's strength and the gap between them in
        points, each brand's strength on eight fixed dimensions, and whose each
        attribute is. Only grouped attributes are listed.
      operationId: getProjectsByProjectIdAttributes
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
        - name: window
          in: query
          required: false
          schema:
            type: string
            enum:
              - 7d
              - 30d
              - 90d
              - 180d
              - 365d
              - custom
        - name: from
          in: query
          required: false
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - name: to
          in: query
          required: false
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - name: engines
          in: query
          required: false
          schema:
            type: string
        - name: compare
          in: query
          required: false
          description: >-
            Up to three brand ids, comma-separated, each a tracked competitor of
            the project. Defaults to the most visible one.
          schema:
            description: >-
              Up to three brand ids, comma-separated, each a tracked competitor
              of the project. Defaults to the most visible one.
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  state:
                    type:
                      - string
                      - 'null'
                  scope:
                    type: object
                    properties:
                      window:
                        type:
                          - string
                          - 'null'
                      from:
                        anyOf:
                          - type: string
                            pattern: ^\d{4}-\d{2}-\d{2}$
                          - type: 'null'
                      to:
                        anyOf:
                          - type: string
                            pattern: ^\d{4}-\d{2}-\d{2}$
                          - type: 'null'
                      read:
                        anyOf:
                          - type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          - type: 'null'
                      answers:
                        anyOf:
                          - type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          - type: 'null'
                      skipped:
                        anyOf:
                          - type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          - type: 'null'
                    required:
                      - window
                      - from
                      - to
                      - read
                      - answers
                      - skipped
                    additionalProperties: false
                  own:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                      name:
                        type: string
                      own:
                        type: boolean
                    required:
                      - id
                      - name
                      - own
                    additionalProperties: false
                  compared:
                    type: array
                    items:
                      type: object
                      properties:
                        brand:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            name:
                              type: string
                            own:
                              type: boolean
                          required:
                            - id
                            - name
                            - own
                          additionalProperties: false
                        answers:
                          anyOf:
                            - type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            - type: 'null'
                        against:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                              label:
                                type: string
                              dimension:
                                anyOf:
                                  - type: string
                                    enum:
                                      - ease_of_use
                                      - features
                                      - fit
                                      - integrations
                                      - pricing
                                      - support
                                      - trust
                                      - scale
                                      - other
                                  - type: 'null'
                              strength:
                                anyOf:
                                  - type: object
                                    properties:
                                      value:
                                        type:
                                          - number
                                          - 'null'
                                      unit:
                                        type: string
                                        enum:
                                          - percent
                                          - points
                                          - count
                                          - score
                                          - rank
                                          - ratio
                                      band:
                                        type:
                                          - number
                                          - 'null'
                                      'n':
                                        type: integer
                                        minimum: -9007199254740991
                                        maximum: 9007199254740991
                                      delta:
                                        type:
                                          - number
                                          - 'null'
                                      within_noise:
                                        type: boolean
                                      low_sample:
                                        type: boolean
                                      state:
                                        type: string
                                        enum:
                                          - measured
                                          - no_data
                                          - never_named
                                      note:
                                        type: string
                                    required:
                                      - value
                                      - unit
                                      - band
                                      - 'n'
                                      - delta
                                      - within_noise
                                      - low_sample
                                      - state
                                    additionalProperties: false
                                    description: >-
                                      A measured number with its uncertainty.
                                      value is null with n = 0 (no answers yet);
                                      within_noise true means a delta is not a
                                      move.
                                  - type: 'null'
                            required:
                              - key
                              - label
                              - dimension
                              - strength
                            additionalProperties: false
                      required:
                        - brand
                        - answers
                        - against
                      additionalProperties: false
                  dimensions:
                    type: array
                    items:
                      type: object
                      properties:
                        dimension:
                          type: string
                          enum:
                            - ease_of_use
                            - features
                            - fit
                            - integrations
                            - pricing
                            - support
                            - trust
                            - scale
                            - other
                        strength:
                          anyOf:
                            - type: object
                              properties:
                                value:
                                  type:
                                    - number
                                    - 'null'
                                unit:
                                  type: string
                                  enum:
                                    - percent
                                    - points
                                    - count
                                    - score
                                    - rank
                                    - ratio
                                band:
                                  type:
                                    - number
                                    - 'null'
                                'n':
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                delta:
                                  type:
                                    - number
                                    - 'null'
                                within_noise:
                                  type: boolean
                                low_sample:
                                  type: boolean
                                state:
                                  type: string
                                  enum:
                                    - measured
                                    - no_data
                                    - never_named
                                note:
                                  type: string
                              required:
                                - value
                                - unit
                                - band
                                - 'n'
                                - delta
                                - within_noise
                                - low_sample
                                - state
                              additionalProperties: false
                              description: >-
                                A measured number with its uncertainty. value is
                                null with n = 0 (no answers yet); within_noise
                                true means a delta is not a move.
                            - type: 'null'
                        gaps:
                          type: array
                          items:
                            type: object
                            properties:
                              brand_id:
                                type: string
                                format: uuid
                                pattern: >-
                                  ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                              strength:
                                anyOf:
                                  - type: object
                                    properties:
                                      value:
                                        type:
                                          - number
                                          - 'null'
                                      unit:
                                        type: string
                                        enum:
                                          - percent
                                          - points
                                          - count
                                          - score
                                          - rank
                                          - ratio
                                      band:
                                        type:
                                          - number
                                          - 'null'
                                      'n':
                                        type: integer
                                        minimum: -9007199254740991
                                        maximum: 9007199254740991
                                      delta:
                                        type:
                                          - number
                                          - 'null'
                                      within_noise:
                                        type: boolean
                                      low_sample:
                                        type: boolean
                                      state:
                                        type: string
                                        enum:
                                          - measured
                                          - no_data
                                          - never_named
                                      note:
                                        type: string
                                    required:
                                      - value
                                      - unit
                                      - band
                                      - 'n'
                                      - delta
                                      - within_noise
                                      - low_sample
                                      - state
                                    additionalProperties: false
                                    description: >-
                                      A measured number with its uncertainty.
                                      value is null with n = 0 (no answers yet);
                                      within_noise true means a delta is not a
                                      move.
                                  - type: 'null'
                              gap:
                                anyOf:
                                  - type: object
                                    properties:
                                      value:
                                        type:
                                          - number
                                          - 'null'
                                      unit:
                                        type: string
                                        enum:
                                          - percent
                                          - points
                                          - count
                                          - score
                                          - rank
                                          - ratio
                                      band:
                                        type:
                                          - number
                                          - 'null'
                                      'n':
                                        type: integer
                                        minimum: -9007199254740991
                                        maximum: 9007199254740991
                                      delta:
                                        type:
                                          - number
                                          - 'null'
                                      within_noise:
                                        type: boolean
                                      low_sample:
                                        type: boolean
                                      state:
                                        type: string
                                        enum:
                                          - measured
                                          - no_data
                                          - never_named
                                      note:
                                        type: string
                                    required:
                                      - value
                                      - unit
                                      - band
                                      - 'n'
                                      - delta
                                      - within_noise
                                      - low_sample
                                      - state
                                    additionalProperties: false
                                    description: >-
                                      A measured number with its uncertainty.
                                      value is null with n = 0 (no answers yet);
                                      within_noise true means a delta is not a
                                      move.
                                  - type: 'null'
                            required:
                              - brand_id
                              - strength
                              - gap
                            additionalProperties: false
                      required:
                        - dimension
                        - strength
                        - gaps
                      additionalProperties: false
                    description: >-
                      The own brand's strength on each of eight fixed dimensions
                      (the share of answers naming it that attach a positive or
                      neutral attribute of the dimension), and each compared
                      brand's strength and the gap in points.
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        label:
                          type: string
                        polarity:
                          type: string
                          enum:
                            - positive
                            - negative
                            - neutral
                        dimension:
                          anyOf:
                            - type: string
                              enum:
                                - ease_of_use
                                - features
                                - fit
                                - integrations
                                - pricing
                                - support
                                - trust
                                - scale
                                - other
                            - type: 'null'
                        strength:
                          anyOf:
                            - type: object
                              properties:
                                value:
                                  type:
                                    - number
                                    - 'null'
                                unit:
                                  type: string
                                  enum:
                                    - percent
                                    - points
                                    - count
                                    - score
                                    - rank
                                    - ratio
                                band:
                                  type:
                                    - number
                                    - 'null'
                                'n':
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                delta:
                                  type:
                                    - number
                                    - 'null'
                                within_noise:
                                  type: boolean
                                low_sample:
                                  type: boolean
                                state:
                                  type: string
                                  enum:
                                    - measured
                                    - no_data
                                    - never_named
                                note:
                                  type: string
                              required:
                                - value
                                - unit
                                - band
                                - 'n'
                                - delta
                                - within_noise
                                - low_sample
                                - state
                              additionalProperties: false
                              description: >-
                                A measured number with its uncertainty. value is
                                null with n = 0 (no answers yet); within_noise
                                true means a delta is not a move.
                            - type: 'null'
                        engines:
                          type: array
                          items:
                            type: string
                        gaps:
                          type: array
                          items:
                            type: object
                            properties:
                              brand_id:
                                type: string
                                format: uuid
                                pattern: >-
                                  ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                              strength:
                                anyOf:
                                  - type: object
                                    properties:
                                      value:
                                        type:
                                          - number
                                          - 'null'
                                      unit:
                                        type: string
                                        enum:
                                          - percent
                                          - points
                                          - count
                                          - score
                                          - rank
                                          - ratio
                                      band:
                                        type:
                                          - number
                                          - 'null'
                                      'n':
                                        type: integer
                                        minimum: -9007199254740991
                                        maximum: 9007199254740991
                                      delta:
                                        type:
                                          - number
                                          - 'null'
                                      within_noise:
                                        type: boolean
                                      low_sample:
                                        type: boolean
                                      state:
                                        type: string
                                        enum:
                                          - measured
                                          - no_data
                                          - never_named
                                      note:
                                        type: string
                                    required:
                                      - value
                                      - unit
                                      - band
                                      - 'n'
                                      - delta
                                      - within_noise
                                      - low_sample
                                      - state
                                    additionalProperties: false
                                    description: >-
                                      A measured number with its uncertainty.
                                      value is null with n = 0 (no answers yet);
                                      within_noise true means a delta is not a
                                      move.
                                  - type: 'null'
                              gap:
                                anyOf:
                                  - type: object
                                    properties:
                                      value:
                                        type:
                                          - number
                                          - 'null'
                                      unit:
                                        type: string
                                        enum:
                                          - percent
                                          - points
                                          - count
                                          - score
                                          - rank
                                          - ratio
                                      band:
                                        type:
                                          - number
                                          - 'null'
                                      'n':
                                        type: integer
                                        minimum: -9007199254740991
                                        maximum: 9007199254740991
                                      delta:
                                        type:
                                          - number
                                          - 'null'
                                      within_noise:
                                        type: boolean
                                      low_sample:
                                        type: boolean
                                      state:
                                        type: string
                                        enum:
                                          - measured
                                          - no_data
                                          - never_named
                                      note:
                                        type: string
                                    required:
                                      - value
                                      - unit
                                      - band
                                      - 'n'
                                      - delta
                                      - within_noise
                                      - low_sample
                                      - state
                                    additionalProperties: false
                                    description: >-
                                      A measured number with its uncertainty.
                                      value is null with n = 0 (no answers yet);
                                      within_noise true means a delta is not a
                                      move.
                                  - type: 'null'
                              standing:
                                anyOf:
                                  - type: string
                                    enum:
                                      - yours
                                      - contested
                                      - theirs
                                  - type: 'null'
                                description: >-
                                  Whose the attribute is against this brand:
                                  yours or theirs when the gap is outside its
                                  band, contested when both brands have it and
                                  the gap is within noise, null otherwise.
                            required:
                              - brand_id
                              - strength
                              - gap
                              - standing
                            additionalProperties: false
                      required:
                        - key
                        - label
                        - polarity
                        - dimension
                        - strength
                        - engines
                        - gaps
                      additionalProperties: false
                  drift:
                    type: array
                    items:
                      type: object
                      properties:
                        engine:
                          type: string
                        occurred_on:
                          anyOf:
                            - type: string
                              pattern: ^\d{4}-\d{2}-\d{2}$
                            - type: 'null'
                      required:
                        - engine
                        - occurred_on
                      additionalProperties: false
                required:
                  - state
                  - scope
                  - own
                  - compared
                  - dimensions
                  - items
                  - drift
                additionalProperties: false
        '400':
          description: The request is invalid; `error.field` names the parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'No live API key in an `Authorization: Bearer` header.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key lacks the scope named in the message, or cannot write.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource in this key's projects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Over the key's or the workspace's rate limit; see `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Busy or timed out; retry after `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: curl
          source: |-
            curl "https://api.citino.ai/v1/projects/{projectId}/attributes" \
              -H "Authorization: Bearer $CITINO_API_KEY"
        - lang: python
          label: Python
          source: |-
            import os
            import requests

            res = requests.get(
                "https://api.citino.ai/v1/projects/{projectId}/attributes",
                headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
            )
            print(res.json())
        - lang: javascript
          label: JavaScript
          source: >-
            const res = await
            fetch("https://api.citino.ai/v1/projects/{projectId}/attributes", {
              headers: {
                Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
              },
            });

            console.log(await res.json());
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                validation, unauthorized, forbidden, not_found, conflict,
                plan_limit, rate_limited, busy, query_timeout
            message:
              type: string
            field:
              type: string
            detail:
              type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from Workspace settings → API keys, sent as `Authorization:
        Bearer <key>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.