openapi: 3.2.0 info: title: G2 Screenshots API version: v2 description: '## Rate Limiting Cloudflare limits requests to the G2 API to **100 requests per second** per source IP address. ' servers: - url: https://{defaultHost} variables: defaultHost: default: data.g2.com tags: - name: Screenshots paths: /api/v2/screenshots: get: summary: Lists screenshots operationId: getScreenshots tags: - Screenshots description: '**Requires `screenshots.read` scope.** ' security: - AccountAPIToken: [] G2OAuth: - openid - profile parameters: - name: page[size] in: query required: false description: 'Number of records per page (default: 25, max: 250)' schema: type: integer minimum: 1 maximum: 250 default: 25 - name: page[after] in: query required: false description: Cursor for fetching the next page of results schema: type: string - name: page[before] in: query required: false description: Cursor for fetching the previous page of results schema: type: string - name: filter[created_at_gt] in: query schema: type: string description: Min time for when a record was created. Using rfc3339 format. - name: filter[created_at_lt] in: query schema: type: string description: Max time for when a record was last updated. Using rfc3339 format. - name: filter[updated_at_gt] in: query schema: type: string description: Min time for when a record was last updated. Using rfc3339 format. - name: filter[updated_at_lt] in: query schema: type: string description: Max time for when a record was last updated. Using rfc3339 format. - name: fields[screenshots] in: query explode: false description: Comma separated list of fields for screenshots to include in response schema: type: array items: type: string enum: - id - product_id - url - created_at - updated_at - file_name - title - description - name: include in: query explode: false description: Comma-separated list of relationships to include (e.g. product,vendor) schema: type: array items: type: string enum: - product - vendor responses: '400': description: with invalid request parameters content: application/vnd.api+json: example: errors: - status: '400' title: 'Invalid parameter: "include" contains unknown items: "foo"' schema: $ref: '#/components/schemas/Errors' '401': description: Unauthenticated content: application/vnd.api+json: example: errors: - status: '401' title: Bad Credentials schema: $ref: '#/components/schemas/Errors' '200': description: With all fields included content: application/vnd.api+json: example: data: - id: 1dadd35b-0e33-46db-8377-000000000002 type: screenshots attributes: product_id: 1dadd35b-0e33-46db-8377-000000000001 url: https://d3cat1s0n6zlx1.cloudfront.net/uploads/attachment/file/47/g2.png created_at: '2021-12-01T00:00:00.000-06:00' updated_at: '2022-01-01T00:00:00.000-06:00' file_name: g2.png title: G2.com description: null links: self: http://data.example.com/api/v2/screenshots?filter%5Bcreated_at_gt%5D=&filter%5Bcreated_at_lt%5D=&filter%5Bupdated_at_gt%5D=&filter%5Bupdated_at_lt%5D=&fields%5Bscreenshots%5D=id,product_id,url,created_at,updated_at,file_name,title,description&include=product,vendor next: null prev: null meta: record_count: 1 schema: type: object required: - data - links properties: data: type: array items: type: object properties: id: type: string type: type: string attributes: type: object required: - created_at - product_id - url properties: id: type: string product_id: type: string url: type: string created_at: type: string format: date-time updated_at: type: string format: date-time file_name: type: string title: type: string description: type: - string - 'null' required: - id - type - attributes included: $ref: '#/components/schemas/included' links: $ref: '#/components/schemas/cursor_pagination' /api/v2/screenshots/{id}: get: summary: Shows a screenshot operationId: getScreenshot tags: - Screenshots description: '**Requires `screenshots.read` scope.** ' security: - AccountAPIToken: [] G2OAuth: - openid - profile parameters: - name: id in: path required: true schema: type: string - name: fields[screenshots] in: query explode: false description: Comma separated list of fields for screenshots to include in response schema: type: array items: type: string enum: - id - product_id - url - created_at - updated_at - file_name - title - description - name: include in: query explode: false description: Comma-separated list of relationships to include (e.g. product,vendor) schema: type: array items: type: string enum: - product - vendor responses: '400': description: with invalid request parameters content: application/vnd.api+json: example: errors: - status: '400' title: 'Invalid parameter: "include" contains unknown items: "foo"' schema: $ref: '#/components/schemas/Errors' '401': description: Unauthenticated content: application/vnd.api+json: example: errors: - status: '401' title: Bad Credentials schema: $ref: '#/components/schemas/Errors' '404': description: With invalid id content: application/vnd.api+json: example: errors: - status: '404' title: Not Found schema: $ref: '#/components/schemas/Errors' '200': description: With all fields included content: application/vnd.api+json: example: data: id: 1dadd35b-0e33-46db-8377-000000000002 type: screenshots attributes: product_id: 1dadd35b-0e33-46db-8377-000000000001 url: https://d3cat1s0n6zlx1.cloudfront.net/uploads/attachment/file/52/g2.png created_at: '2021-12-01T00:00:00.000-06:00' updated_at: '2022-01-01T00:00:00.000-06:00' file_name: g2.png title: G2.com description: null schema: type: object required: - data properties: data: type: object properties: id: type: string type: type: string attributes: type: object required: - created_at - url properties: id: type: string product_id: type: string url: type: string created_at: type: string format: date-time updated_at: type: string format: date-time file_name: type: string title: type: string description: type: - string - 'null' included: $ref: '#/components/schemas/included' /api/v2/products/{product_id}/screenshots: get: summary: Lists Screenshots related to given product operationId: getProductScreenshots tags: - Screenshots description: '**Requires `products.screenshots.read` scope.** ' security: - AccountAPIToken: [] G2OAuth: - openid - profile parameters: - name: page[size] in: query required: false description: 'Number of records per page (default: 25, max: 250)' schema: type: integer minimum: 1 maximum: 250 default: 25 - name: page[after] in: query required: false description: Cursor for fetching the next page of results schema: type: string - name: page[before] in: query required: false description: Cursor for fetching the previous page of results schema: type: string - name: product_id in: path required: true schema: type: string - name: filter[created_at_gt] in: query description: Min time for when a record was created. Using rfc3339 format. - name: filter[created_at_lt] in: query description: Max time for when a record was last updated. Using rfc3339 format. - name: filter[updated_at_gt] in: query description: Min time for when a record was last updated. Using rfc3339 format. - name: filter[updated_at_lt] in: query description: Max time for when a record was last updated. Using rfc3339 format. - name: fields[screenshots] in: query explode: false description: Comma separated list of fields for screenshots to include in response schema: type: array items: type: string enum: - id - product_id - url - created_at - updated_at - file_name - title - description - name: include in: query explode: false description: Comma-separated list of relationships to include (e.g. product,vendor) schema: type: array items: type: string enum: - product - vendor responses: '401': description: Unauthenticated content: application/vnd.api+json: example: errors: - status: '401' title: Bad Credentials schema: $ref: '#/components/schemas/Errors' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/Errors' examples: when user does not have access to the product: value: errors: - status: '403' title: You do not have access to that resource when user has product access but lacks the required license: value: errors: - status: '403' title: Your current plan does not provide access to this resource. To unlock it, explore your upgrade options. Talk to G2 at the link below links: type: - https://sell.g2.com/strategy-session-with-customers?utm_source=g2&utm_medium=product&utm_campaign=g2-mcp-demo-request&utm_content=none&utm_term=none example: errors: - status: '403' title: Your current plan does not provide access to this resource. To unlock it, explore your upgrade options. Talk to G2 at the link below links: type: - https://sell.g2.com/strategy-session-with-customers?utm_source=g2&utm_medium=product&utm_campaign=g2-mcp-demo-request&utm_content=none&utm_term=none '400': description: with invalid request parameters content: application/vnd.api+json: example: errors: - status: '400' title: 'Invalid parameter: "include" contains unknown items: "foo"' schema: $ref: '#/components/schemas/Errors' '404': description: With invalid id content: application/vnd.api+json: example: errors: - status: '404' title: Not Found schema: $ref: '#/components/schemas/Errors' '200': description: With all fields included content: application/vnd.api+json: example: data: - id: a89fa6e8-f5f4-47a2-8746-000000000002 type: screenshots attributes: product_id: a89fa6e8-f5f4-47a2-8746-000000000001 url: https://d3cat1s0n6zlx1.cloudfront.net/uploads/attachment/file/64/g2.png created_at: '2021-12-01T00:00:00.000-06:00' updated_at: '2022-01-01T00:00:00.000-06:00' file_name: g2.png title: G2.com description: null links: self: http://data.example.com/api/v2/products/a89fa6e8-f5f4-47a2-8746-000000000001/screenshots?filter%5Bcreated_at_gt%5D=&filter%5Bcreated_at_lt%5D=&filter%5Bupdated_at_gt%5D=&filter%5Bupdated_at_lt%5D=&fields%5Bscreenshots%5D=id,product_id,url,created_at,updated_at,file_name,title,description&include=product,vendor next: null prev: null meta: record_count: 1 schema: type: object required: - data - links properties: data: type: array items: type: object properties: id: type: string type: type: string attributes: type: object required: - created_at - product_id - url properties: product_id: type: string url: type: string created_at: type: string format: date-time updated_at: type: string format: date-time file_name: type: string title: type: string description: type: - string - 'null' required: - id - type - attributes included: $ref: '#/components/schemas/included' links: $ref: '#/components/schemas/cursor_pagination' components: schemas: Errors: type: object properties: errors: type: array items: type: object properties: status: type: string title: type: string links: type: - object - 'null' source: type: - object - 'null' cursor_pagination: type: object properties: next: type: - string - 'null' prev: type: - string - 'null' self: type: - string - 'null' included: type: array items: type: object properties: id: type: string type: type: string attributes: type: object relationships: type: object securitySchemes: AccountAPIToken: type: http scheme: bearer G2OAuth: type: oauth2 flows: authorizationCode: tokenUrl: https://www.g2.com/oauth/token authorizationUrl: https://www.g2.com/oauth/authorize scopes: openid: OpenID Connect default scope profile: Profile information on current user data_subscriptions.read: Read Data Subscription records data_subscriptions.read_write: Modify Data Subscription records partner:partner-id.read: Access records created in Partner realm performance_analytics.read: Read Performance Analytics data