BrightEdge

BrightEdge chrome_extension API

The chrome_extension API from BrightEdge — 12 operation(s) for chrome_extension.

GitHub OpenAPI

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/brightedge/refs/heads/main/authentication/brightedge-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/brightedge/refs/heads/main/openapi/brightedge-chrome-extension-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/brightedge/refs/heads/main/conventions/brightedge-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/brightedge/refs/heads/main/errors/brightedge-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/brightedge/refs/heads/main/lifecycle/brightedge-lifecycle.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/brightedge/refs/heads/main/data-model/brightedge-data-model.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/brightedge/refs/heads/main/conformance/brightedge-conformance.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/brightedge/refs/heads/main/agentic-access/brightedge-agentic-access.yml

OpenAPI Specification

brightedge-chrome-extension-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: BrightEdge Platform accounts chrome_extension API
  description: This API provides the ability to integrate with BrightEdge Platform
  version: 5.0.0
tags:
- name: chrome_extension
paths:
  /5.0/chrome_extension/overview/images:
    post:
      tags:
      - chrome_extension
      summary: Get Image tags Alt texts
      operationId: images_5_0_chrome_extension_overview_images_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImagesInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
                title: Response Images 5 0 Chrome Extension Overview Images Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - http_basic: []
      - forwarded_http_basic: []
      - session_cookie: []
      - session_header: []
  /5.0/chrome_extension/overview/content:
    post:
      tags:
      - chrome_extension
      summary: Get Page Contents
      operationId: content_5_0_chrome_extension_overview_content_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContentInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Content'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - http_basic: []
      - forwarded_http_basic: []
      - session_cookie: []
      - session_header: []
  /5.0/chrome_extension/overview/web_vitals:
    get:
      tags:
      - chrome_extension
      summary: Get Web Vitals
      operationId: web_vitals_5_0_chrome_extension_overview_web_vitals_get
      parameters:
      - required: true
        schema:
          type: string
          title: Url
        name: url
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebVitals'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - http_basic: []
      - forwarded_http_basic: []
      - session_cookie: []
      - session_header: []
  /5.0/chrome_extension/keywords/track_keywords:
    post:
      tags:
      - chrome_extension
      summary: Track Keywords
      operationId: track_keywords_5_0_chrome_extension_keywords_track_keywords_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrackKeywordsInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeywordGroups'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - http_basic: []
      - forwarded_http_basic: []
      - session_cookie: []
      - session_header: []
  /5.0/chrome_extension/keywords/compare_domains:
    post:
      tags:
      - chrome_extension
      summary: Compare Domains
      operationId: compare_domains_5_0_chrome_extension_keywords_compare_domains_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainComparisonInput'
        required: true
      responses:
        '200':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - http_basic: []
      - forwarded_http_basic: []
      - session_cookie: []
      - session_header: []
  /5.0/chrome_extension/keywords/research_keywords:
    post:
      tags:
      - chrome_extension
      summary: Research Keywords
      operationId: research_keywords_5_0_chrome_extension_keywords_research_keywords_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResearchKeywordsInput'
        required: true
      responses:
        '200':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - http_basic: []
      - forwarded_http_basic: []
      - session_cookie: []
      - session_header: []
  /latest5/chrome_extension/overview/images:
    post:
      tags:
      - chrome_extension
      summary: Get Image tags Alt texts
      operationId: images_latest5_chrome_extension_overview_images_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImagesInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
                title: Response Images Latest5 Chrome Extension Overview Images Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - http_basic: []
      - forwarded_http_basic: []
      - session_cookie: []
      - session_header: []
  /latest5/chrome_extension/overview/content:
    post:
      tags:
      - chrome_extension
      summary: Get Page Contents
      operationId: content_latest5_chrome_extension_overview_content_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContentInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Content'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - http_basic: []
      - forwarded_http_basic: []
      - session_cookie: []
      - session_header: []
  /latest5/chrome_extension/overview/web_vitals:
    get:
      tags:
      - chrome_extension
      summary: Get Web Vitals
      operationId: web_vitals_latest5_chrome_extension_overview_web_vitals_get
      parameters:
      - required: true
        schema:
          type: string
          title: Url
        name: url
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebVitals'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - http_basic: []
      - forwarded_http_basic: []
      - session_cookie: []
      - session_header: []
  /latest5/chrome_extension/keywords/track_keywords:
    post:
      tags:
      - chrome_extension
      summary: Track Keywords
      operationId: track_keywords_latest5_chrome_extension_keywords_track_keywords_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrackKeywordsInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeywordGroups'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - http_basic: []
      - forwarded_http_basic: []
      - session_cookie: []
      - session_header: []
  /latest5/chrome_extension/keywords/compare_domains:
    post:
      tags:
      - chrome_extension
      summary: Compare Domains
      operationId: compare_domains_latest5_chrome_extension_keywords_compare_domains_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainComparisonInput'
        required: true
      responses:
        '200':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - http_basic: []
      - forwarded_http_basic: []
      - session_cookie: []
      - session_header: []
  /latest5/chrome_extension/keywords/research_keywords:
    post:
      tags:
      - chrome_extension
      summary: Research Keywords
      operationId: research_keywords_latest5_chrome_extension_keywords_research_keywords_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResearchKeywordsInput'
        required: true
      responses:
        '200':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - http_basic: []
      - forwarded_http_basic: []
      - session_cookie: []
      - session_header: []
components:
  schemas:
    KeywordGroups:
      properties:
        keyword_groups:
          items:
            $ref: '#/components/schemas/KeywordGroupDetail'
          type: array
          title: Keyword Groups
      type: object
      required:
      - keyword_groups
      title: KeywordGroups
    ContentInput:
      properties:
        account_id:
          type: integer
          title: Account Id
        se_group_id:
          type: integer
          title: Se Group Id
        url:
          type: string
          title: Url
      type: object
      required:
      - account_id
      - se_group_id
      - url
      title: ContentInput
    Content:
      properties:
        word_count:
          type: integer
          title: Word Count
        headings:
          $ref: '#/components/schemas/Headings'
      type: object
      required:
      - word_count
      - headings
      title: Content
    Pagination:
      properties:
        offset:
          type: integer
          title: Offset
          default: 0
        limit:
          type: integer
          title: Limit
          default: 25
      type: object
      title: Pagination
    ResearchKeywordsInput:
      properties:
        keyword:
          type: string
          title: Keyword
        se_group_id:
          type: string
          title: Se Group Id
        account_id:
          type: integer
          title: Account Id
      type: object
      required:
      - keyword
      - se_group_id
      - account_id
      title: ResearchKeywordsInput
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Headings:
      properties:
        H1:
          items:
            type: string
          type: array
          title: H1
          default: []
        H2:
          items:
            type: string
          type: array
          title: H2
          default: []
      type: object
      title: Headings
    TrackKeywordsInput:
      properties:
        account_id:
          type: integer
          title: Account Id
        pagination:
          $ref: '#/components/schemas/Pagination'
      type: object
      required:
      - account_id
      title: TrackKeywordsInput
    KeywordGroupDetail:
      properties:
        group_id:
          type: integer
          title: Group Id
        keyword_group_name:
          type: string
          title: Keyword Group Name
      type: object
      required:
      - group_id
      - keyword_group_name
      title: KeywordGroupDetail
    WebVitals:
      properties:
        lcp:
          type: string
          title: Lcp
          default: ''
        fid:
          type: string
          title: Fid
          default: ''
        cls:
          type: string
          title: Cls
          default: ''
        inp:
          type: string
          title: Inp
          default: ''
      type: object
      title: WebVitals
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DomainComparisonInput:
      properties:
        account_id:
          type: integer
          title: Account Id
        base_domain:
          type: string
          title: Base Domain
        compare_domain:
          type: string
          title: Compare Domain
        se_group_id:
          type: string
          title: Se Group Id
      type: object
      required:
      - account_id
      - base_domain
      - compare_domain
      - se_group_id
      title: DomainComparisonInput
    ImagesInput:
      properties:
        account_id:
          type: integer
          title: Account Id
        se_group_id:
          type: integer
          title: Se Group Id
        url:
          type: string
          title: Url
      type: object
      required:
      - account_id
      - se_group_id
      - url
      title: ImagesInput
  securitySchemes:
    http_basic:
      type: http
      scheme: basic
    forwarded_http_basic:
      type: apiKey
      in: header
      name: X-Forwarded-Authorization
    session_cookie:
      type: apiKey
      in: cookie
      name: BRIGHTEDGE
    session_header:
      type: apiKey
      in: header
      name: X-BRIGHTEDGE-SESSION
    api_token_header:
      type: apiKey
      in: header
      name: X-Token
    bearer_token:
      type: apiKey
      in: header
      name: Bearer-Token