RapidAPI Hub

https://docs.rapidapi.com
Admin
RapidAPI Hub is a comprehensive API marketplace and management platform that enables developers to...
Tokens:298,791
Snippets:1,971
Trust Score:9.9
Update:1 day ago
Show doc for...
Tokens:
Raw
### createApplicationAuthorization (Node Axios Example)

Source: https://docs.rapidapi.com/docs/apps-and-authorizations

Node.js Axios example for calling the createApplicationAuthorization mutation with OAuth2 authorization.

```APIDOC
## createApplicationAuthorization (Node Axios Example)

### Description
Node.js Axios example for calling the createApplicationAuthorization mutation with OAuth2 authorization.

### Method
POST

### Endpoint
Your RapidAPI endpoint URL (e.g., https://YOUR URL.p.rapidapi.com/)

### Headers
- **content-type** (string) - Required - `application/json`
- **X-RapidAPI-Key** (string) - Required - API key from your calling context (team or user).
- **X-RapidAPI-Host** (string) - Required - Your RapidAPI host.
- **x-rapidapi-identity-key** (string) - Required - API key from your Personal Account if calling from a team context.

### Request Body (GraphQL)
- **query** (string) - Required - The GraphQL mutation string.
- **variables.input** (object) - Required - Input object with fields as described in the OAuth2 example.

### Request Example
```javascript
const axios = require("axios");

const URL = "https://YOUR URL.p.rapidapi.com/";
const HOST = "YOUR HOST.rapidapi.com";
const TEAMORUSERKEY = "YOUR ID"; // API key from your calling context
const USERKEY = "YOUR ID"; // needed if calling the Platform API from a team context - it is the API key from your Personal Account
const PROJECTID = "YOUR PROJECT ID"; // this is the app id
const AUTHNAME = "YOUR AUTHORIZATION NAME";
const CLIENTID = "YOUR CLIENT ID";
const CLIENTSECRET = "YOUR CLIENT SECRET"; // optional for AUTHORIZATION_CODE grant types
const GATEWAYIDARRAY = [YOUR GATEWAY ID]; // keep the brackets - it is a single value array
const GRANTTYPE = "CLIENT_CREDENTIALS"; // or "AUTHORIZATION_CODE"

const options = {
  method: "POST",
  url: URL,
  headers: {
    "content-type": "application/json",
    "X-RapidAPI-Key": TEAMORUSERKEY,
    "X-RapidAPI-Host": HOST,
    "x-rapidapi-identity-key": USERKEY,
  },
  data: {
    query: `mutation CreateApplicationAuthorization($input: AppAuthorizationCreateInput!) {
  createApplicationAuthorization(input: $input) {
    id
    name
    applicationId
    status
    createdAt
    authorizationType
    authorizationValues
  }
}`,
    variables: {
      input: {
        projectId: PROJECTID,
        name: AUTHNAME,
        authorizationType: "OAUTH2",
        authorizationValues:
          '{"clientId":"' + CLIENTID + '","clientSecret":"' + CLIENTSECRET + '"}',
        gatewayIds: GATEWAYIDARRAY,
        grantType: GRANTTYPE,
      },
    },
  },
};

axios
  .request(options)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.error(error);
  });
```

### Response
#### Success Response
- **data** (object) - Contains the result of the mutation.

#### Response Example
```json
{
  "data": {
    "createApplicationAuthorization": {
      "id": "...",
      "name": "...",
      "applicationId": "...",
      "status": "...",
      "createdAt": "...",
      "authorizationType": "OAUTH2",
      "authorizationValues": "..."
    }
  }
}
```
```

--------------------------------

### Node Axios example for createApplicationAuthorization

Source: https://docs.rapidapi.com/docs/apps-and-authorizations

JavaScript example using Axios to call the createApplicationAuthorization mutation. Requires placeholders for URL, host, API keys, project ID, and OAuth2 credentials. The grantType can be CLIENT_CREDENTIALS or AUTHORIZATION_CODE.

```JavaScript
const axios = require("axios");

const URL = "https://YOUR URL.p.rapidapi.com/";
const HOST = "YOUR HOST.rapidapi.com";
const TEAMORUSERKEY = "YOUR ID"; // API key from your calling context
const USERKEY = "YOUR ID"; // needed if calling the Platform API from a team context - it is the API key from your Personal Account
const PROJECTID = "YOUR PROJECT ID"; // this is the app id
const AUTHNAME = "YOUR AUTHORIZATION NAME";
const CLIENTID = "YOUR CLIENT ID";
const CLIENTSECRET = "YOUR CLIENT SECRET"; // optional for AUTHORIZATION_CODE grant types
const GATEWAYIDARRAY = [YOUR GATEWAY ID]; // keep the brackets - it is a single value array
const GRANTTYPE = "CLIENT_CREDENTIALS"; // or "AUTHORIZATION_CODE

const options = {
  method: "POST",
  url: URL,
  headers: {
    "content-type": "application/json",
    "X-RapidAPI-Key": TEAMORUSERKEY,
    "X-RapidAPI-Host": HOST,
    "x-rapidapi-identity-key": USERKEY,
  },
  data: {
    query: `mutation CreateApplicationAuthorization($input: AppAuthorizationCreateInput!) {
  createApplicationAuthorization(input: $input) {
    id
    name
    applicationId
    status
    createdAt
    authorizationType
    authorizationValues
  }
}`,
    variables: {
      input: {
        projectId: PROJECTID,
        name: AUTHNAME,
        authorizationType: "OAUTH2",
        authorizationValues:
          '{"clientId":"' + CLIENTID + '","clientSecret":"' + CLIENTSECRET + '"}',
        gatewayIds: GATEWAYIDARRAY,
        grantType: GRANTTYPE,
      },
    },
  },
};

axios
  .request(options)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.error(error);
  });
```

--------------------------------

### Configuration for GraphQL Example

Source: https://docs.rapidapi.com/docs/example-reading-a-users-apps-and-authorizations-graphql

JSON configuration with placeholders for hosts, base URLs, key, user email, and admin user ID.

```json
{
    "rapidapi_host_rest": "[HOST FROM REST SAMPLE CODE].rapidapi.com",
    "base_url_rest": "https://[URL FROM REST SAMPLE CODE].rapidapi.com/v1/",
    "rapidapi_host_gql": "[HOST FROM GQL SAMPLE CODE].rapidapi.com",
    "base_url_gql": "[URL FROM REST SAMPLE CODE].rapidapi.com/",
    "key": "[KEY FROM TEAM WITH ENTERPRISE PLATFORM API ACCESS]",
    "useremail": "[email protected]",
    "admin_user_id": "5713300"
}
```

--------------------------------

### x-rapidapi-info object example

Source: https://docs.rapidapi.com/docs/adding-and-updating-openapi-documents

Example of the x-rapidapi-info object at the root level of an OpenAPI document. Contains read-only apiId and apiVersionId fields used for Platform API calls.

```JSON
"x-rapidapi-info": {
   "apiId": "api_5ad6a620-6325-456c-b97f-6296331e439a",
   "apiVersionId": "apiversion_be84abe7-7f3a-4a85-9610-cb8ad0c6c806"
},
```

--------------------------------

### x-gateways array example

Source: https://docs.rapidapi.com/docs/adding-and-updating-openapi-documents

Example of the x-gateways array at the root level of an OpenAPI document. Contains url fields for API gateways. If not specified, defaults to an empty array. Gateways must be pre-defined by an Environment Admin or import fails.

```JSON
"x-gateways": [{ "url": "rapidapi.com" }, { "url": "example.com" }],
```

--------------------------------

### Sample response for governance metrics

Source: https://docs.rapidapi.com/docs/hub-usage-metrics-gql-papi

Example response from the getGovernanceMetrics query showing the structure and sample values for each metric.

```json
{
  "data": {
    "metrics": {
      "users": {
        "totalValue": 150,
        "currentPeriodValue": 1,
        "previousPeriodValue": 0,
        "__typename": "Metric"
      },

      "teams": {
        "totalValue": 45,
        "currentPeriodValue": 0,
        "previousPeriodValue": 0,
        "__typename": "Metric"
      },

      "subscribers": {
        "totalValue": 117,
        "currentPeriodValue": 0,
        "previousPeriodValue": 0,
        "__typename": "Metric"
      },

      "organizations": {
        "totalValue": 28,
        "currentPeriodValue": 0,
        "previousPeriodValue": 0,
        "__typename": "Metric"
      },

      "organizationUsers": {
        "totalValue": 84,
        "__typename": "Metric"
      },

      "providers": {
        "totalValue": 58,
        "currentPeriodValue": 0,
        "previousPeriodValue": 0,
        "__typename": "Metric"
      },

      "admins": {
        "totalValue": 45,
        "__typename": "MetricBase"
      },

      "__typename": "Metrics"
    }
  }
}
```

--------------------------------

### getAppsForAnyUser.js - Read User's Apps and Authorizations

Source: https://docs.rapidapi.com/docs/example-view-apps-and-authorizations

This JavaScript file uses a combination of GraphQL and REST Platform APIs to read a user's apps and authorizations. It requires a config.json file with a X-RapidAPI-Key from a team with enterprise access, and uses on-behalf-of functionality to access any user's data. The example is approximately 50 percent slower than the primarily GraphQL example.

```javascript
const axios = require("axios").default;

let optionsCommonRest;
let optionsCommonGql;

let resultsLog = []; //used to log messages and a subset of the data obtained

// set specific user email address, Hub urls, key, category and preferences in config.json
let config = require("./config.json");

optionsCommonRest = {
  headers: {
    "x-rapidapi-host": config.rapidapi_host_rest,
    "x-rapidapi-key": config.key,
  },
};

optionsCommonGql = {
  method: "POST",
  url: config.base_url_gql,
  headers: {
    "x-rapidapi-host": config.rapidapi_host_gql,
    "x-rapidapi-key": config.key,
    "content-type": "application/json",
  },
};

runAll();

async function runAll() {
  console.log("working...");
  console.time("execution time");
  let results = {};

  results = await getUserByEmail(results);
  if (results.aUser[0]) {
    results = await getUserTeamIds(results);
    results = await getUserTeamNames(results);

    results.personalApps = await getApps(results.aUser[0].id);
    results = await getAllPersonalAppDetails(results);
    results = await getKeysForAllPersonalApps(results);

    results = await getTeamApps(results);
    results = await getAllTeamAppDetails(results);
    results = await getKeysForAllTeamApps(results);
    logResults(results);
  } else {
    resultsLog.push(`User ${config.useremail} not found!`);
    displayResultsLog();
  }

  console.timeEnd("execution time");
  return;
}

async function getUserByEmail(resultObj = {}) {
  const optionsUnique = {
    method: "GET",
    url: `${config.base_url_rest}admin/users`,
    params: { email: config.useremail },
  };
  const options = { ...optionsCommonRest, ...optionsUnique };
  let response = await axios.request(options);
  let locResults = {};
  locResults.aUser = response.data;
  return (resultObj = { ...resultObj, ...locResults });
}

async function getUserTeamIds(resultObj = {}) {
  if (!resultObj.aUser[0].id) return;
  const optionsUnique = {
    method: "GET",
    url: `${config.base_url_rest}admin/users/${resultObj.aUser[0].id}/teams`,
    params: { email: config.useremail },
  };
  const options = { ...optionsCommonRest, ...optionsUnique };
  let response = await axios.request(options);
  let locResults = {};
  locResults.aUserTeams = [];
  response.data.forEach((teamId) => {
    locResults.aUserTeams.push({ teamId: teamId }); // create a new object for each team
  });
  return (resultObj = { ...resultObj, ...locResults });
}

async function getUserTeamNames(resultObj) {
  const promises = resultObj.aUserTeams.map((team) =>
    getTeamNameFromID(team.teamId, resultObj.aUser[0].id)
  );
  const teamNames = await Promise.all(promises);
  resultObj.aUserTeams.forEach((team, index) => {
    team.name = teamNames[index];
  });
  return resultObj;
}

async function getTeamNameFromID(teamId, userId) {
  let teamName;
  const optionsUnique = {
    data: {
      query: `query Team($id: ID!) {
        team(id: $id) {
            id
            slugifiedName
            name
            createdAt
            ProjectAcls {
              Project {
                id
                name
              }
            }
          }
      }`,
      variables: { id: teamId },
    },
  };
  const optionsCommonClone = JSON.parse(JSON.stringify(optionsCommonGql)); // deep clone
  let options = { ...optionsCommonClone, ...optionsUnique };
  options.headers["on-behalf-of"] = userId;
  options = await transformOptionsForOnBehalfOf(options, userId, "user");

  let response = await axios.request(options);
  return (
    response?.data?.data?.team?.name || "team name not found" + " for " + teamId
  );
}
```

--------------------------------

### Get configured roles (GraphQL query)

Source: https://docs.rapidapi.com/docs/graphql-platform-api-examples-users-teams-and-roles

Query roles with a filter. The example uses roleLevels to filter for USER_ENVIRONMENT roles.

```GraphQL
query Roles($where: RoleWhereInput!) {
  roles(where: $where) {

    edges {
      node {
        id
        name
        permissions {
          id
          rolePermission {
          granted
          readOnly
        }
        }
      }
      cursor
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
  }
}
```

--------------------------------

### Webhook body with substituted values

Source: https://docs.rapidapi.com/docs/webhook-alerts

Example JSON body showing the result after variable substitution, with actual values like 'Get Products Test' and 'MyStore API'.

```JSON
{
    "text": "Get Products Test in MyStore API has failed after 534 ms. This test was executed in Hong Kong location."
}
```

--------------------------------

### Configuration File Example

Source: https://docs.rapidapi.com/docs/example-creating-and-deleting-authorizations

A JSON configuration file with placeholders for API hosts, base URLs, keys, and user IDs. It includes a flag to delete authorization after creation.

```json
{
    "rapidapi_host_rest": "[HOST FROM REST SAMPLE CODE].rapidapi.com",
    "base_url_rest": "https://[URL FROM REST SAMPLE CODE].rapidapi.com/v1/",
    "rapidapi_host_gql": "[HOST FROM GQL SAMPLE CODE].rapidapi.com",
    "base_url_gql": "[URL FROM REST SAMPLE CODE].rapidapi.com/",
    "key": "[KEY FROM TEAM WITH ENTERPRISE PLATFORM API ACCESS]",
    "useremail": "[email protected]",
    "admin_user_id": "5713300",
    "create_auth_app_id": "4912903",
    "delete_auth_after_creation": true
}
```

--------------------------------

### Query tutorials

Source: https://docs.rapidapi.com/docs/papi-gql-examples-api-documentation

Reads the tutorials for a specified API and version. Requires the API ID and version ID as variables.

```APIDOC
## Query tutorials

### Description
Reads the tutorials for a specified API and version.

### Method
QUERY

### Endpoint
GraphQL query: `tutorials`

### Parameters
#### Variables
- **id** (ID!) - Required - The API ID.
- **versionId** (ID!) - Required - The API version ID.

### Request Example
```graphql
query tutorials($id: ID!, $versionId: ID!) {
  tutorials(where: { apiId: $id, apiVersion: $versionId }) {
    nodes {
      id
      slugifiedName
      published
      title
      content
      thumbnailURL
      publishedDate
      readTime
      __typename
    }
    __typename
  }
}
```

### Variables Example
```json
{
  "id": "api_b766b545-cd34-4b8a-8ec9-0e994cf6ed80",
  "versionId": "apiversion_1de8cd3a-94ec-45f0-b193-8d6f9a04dcd4"
}
```

### Response
#### Success Response
Returns a list of tutorial nodes with fields: `id`, `slugifiedName`, `published`, `title`, `content`, `thumbnailURL`, `publishedDate`, `readTime`, and `__typename`.

```

--------------------------------

### Example variables for apiTrafficAnalyticsLogs

Source: https://docs.rapidapi.com/docs/api-traffic-logs

Example JSON variables for the query, filtering by API ID and date range, ordering by date descending, and paginating with first 10 results.

```json
{
  "where": {
    "apiIds": [
      "api_28f03d6e-955e-4f13-bed8-f574ff7530a2"
    ],
    "fromDate": "2024-03-23T07:00:00.000Z",
    "toDate": "2024-03-30T22:46:09.121Z",
    "timeOffset": 0
  },
  "orderBy": [
    {
      "by": "DESC",
      "fieldName": "DATE_TIME"
    }
  ],
  "pagination": {
    "first": 10,
    "after": ""
  }
}
```

--------------------------------

### Create a tutorial with createTutorial mutation

Source: https://docs.rapidapi.com/docs/papi-gql-examples-api-documentation

Use this GraphQL mutation to add a tutorial to an API. Requires API ID, version ID, title, content, and published status; thumbnailURL is optional.

```GraphQL
mutation CreateTutorial(
  $id: ID!
  $versionId: ID!
  $title: String!
  $content: String!
  $published: Boolean!
  $thumbnailURL: String
) {
  createTutorial(
    tutorial: {
      apiId: $id
      apiVersion: $versionId
      title: $title
      content: $content
      published: $published
      thumbnailURL: $thumbnailURL
    }
  ) {
    id
  }
}
```

```JSON
{
  "id": "api_b766b545-cd34-4b8a-8ec9-0e994cf6ed80",
  "versionId": "apiversion_1de8cd3a-94ec-45f0-b193-8d6f9a04dcd4",
  "title": "Tutorial 2",
  "content": "**Tutorial** content.",
  "published": true
}
```

--------------------------------

### Mutation CreateTutorial

Source: https://docs.rapidapi.com/docs/papi-gql-examples-api-documentation

Adds a new tutorial to an API. Requires the API ID, version ID, title, content, and published status; thumbnailURL is optional.

```APIDOC
## Mutation CreateTutorial

### Description
Adds a new tutorial to an API.

### Method
MUTATION

### Endpoint
GraphQL mutation: `createTutorial`

### Parameters
#### Variables
- **id** (ID!) - Required - The API ID.
- **versionId** (ID!) - Required - The API version ID.
- **title** (String!) - Required - The tutorial title.
- **content** (String!) - Required - The tutorial content.
- **published** (Boolean!) - Required - Whether the tutorial is published.
- **thumbnailURL** (String) - Optional - The thumbnail URL.

### Request Example
```graphql
mutation CreateTutorial(
  $id: ID!
  $versionId: ID!
  $title: String!
  $content: String!
  $published: Boolean!
  $thumbnailURL: String
) {
  createTutorial(
    tutorial: {
      apiId: $id
      apiVersion: $versionId
      title: $title
      content: $content
      published: $published
      thumbnailURL: $thumbnailURL
    }
  ) {
    id
  }
}
```

### Variables Example
```json
{
  "id": "api_b766b545-cd34-4b8a-8ec9-0e994cf6ed80",
  "versionId": "apiversion_1de8cd3a-94ec-45f0-b193-8d6f9a04dcd4",
  "title": "Tutorial 2",
  "content": "**Tutorial** content.",
  "published": true
}
```

### Response
#### Success Response
Returns the `id` of the created tutorial.

```

--------------------------------

### Example of x-documentation object in JSON

Source: https://docs.rapidapi.com/docs/adding-and-updating-openapi-documents

Shows the structure of the x-documentation object with readme, spotlights, and tutorials arrays. The readme field can be a string or a link. Spotlights and tutorials updates are not supported.

```JSON
"x-documentation": {
     "readme": "This is my readme for the main api",
     "spotlights": [{
       "title": "main-spotlight",
       "description": "This is main spotlight description...",
       "link": "https://en.wikipedia.org/wiki/Image"
     },
     {
       "title": "other-spotlight",
       "description": "This is another spotlight description...",
       "link": "https://en.wikipedia.org/wiki/Computer"
     }],
     "tutorials": [{
       "title": "main-tutorial",
       "description": "This is main tutorial description...",
       "link": "https://dytvr9ot2sszz.cloudfront.net/wp-content/uploads/2019/05/1200x628_logstash-tutorial-min.jpg"
     },
     {
       "title": "other-tutorial",
       "description": "This is other tutorial description...",
       "link": "https://i.ytimg.com/vi/B6nLuyVOk4k/maxresdefault.jpg"
     }]
   },
```

--------------------------------

### Example response for calculatedStatistics query

Source: https://docs.rapidapi.com/docs/traffic-analytics-api

Example response from the calculatedStatistics query, showing aggregated statistics for the last 30 days with daily resolution. Includes request totals, error rates, and latency metrics.

```json
{
    "data": {
        "calculatedStatistics": {
            "requeststotal": 2735996208,
            "requestsmax": 127399610,
            "requestsmin": 40089284,
            "requestsavg": 91199873.6,
            "requeststps": 1055.55,
            "errorsavg": 0.03,
            "errorsmedian": 0.03,
            "errorsmax": 0.06,
            "errorsmin": 0.02,
            "errorstotal": 84327307,
            "latencyavg": 1203.03,
            "latencymedian": 486,
            "latencymax": 75919269,
            "latencymin": 0,
        }
    }
}
```

--------------------------------

### Example response for apiTrafficAnalyticsLogs

Source: https://docs.rapidapi.com/docs/api-traffic-logs

Example JSON response showing totalCount and nodes with log details. Includes consumer info, endpoint, HTTP method, latency, call time, origin country, status, version, and payload flag.

```json
{
  "data": {
    "apiTrafficAnalyticsLogs": {
      "totalCount": 152,
      "nodes": [
        {
          "requestId": "8c3d64b72726fe465d833a5c189e1d7401408690ecb8769c2518daddeacc6486",
          "consumer": {
            "name": "auser",
            "username": null,
            "slugifiedName": "auser",
            "thumbnail": "https://s3.amazonaws.com/rapidapi-prod-user/d5a69b00-1eee-44b4-b33d-446e987d3c7b",
            "email": "[email protected]",
            "__typename": "Entity"
          },

          "endpointRoute": "",
          "endpointId": "apiendpoint_37adc863-e838-45d5-ae73-d87007fcac93",
          "httpMethod": "POST",
          "apiLatency": 318,
          "callTime": "2024-03-29T22:54:33.000Z",
          "callTimeUTC": "2024-03-29T22:54:33.000Z",
          "originCountryName": "United States",
          "httpStatus": 200,
          "apiVersionName": "v1",
          "isPayloadExist": true,
          "__typename": "AnalyticsStatsLog"
        },
        {
          "requestId": "0b34862b2717dfb663cff703a81ce9fea548426727866907ab64e262e950c5e8",
          "consumer": {
            "name": "auser",
            "username": null,
            "slugifiedName": "auser",
            "thumbnail": "https://s3.amazonaws.com/rapidapi-prod-user/d5a69b00-1eee-44b4-b33d-446e987d3c7b",
            "email": "[email protected]",
            "__typename": "Entity"
          },

          "endpointRoute": "",
          "endpointId": "apiendpoint_37adc863-e838-45d5-ae73-d87007fcac93",
          "httpMethod": "POST",
          "apiLatency": 272,
          "callTime": "2024-03-29T13:50:57.000Z",
          "callTimeUTC": "2024-03-29T13:50:57.000Z",
          "originCountryName": "United States",
          "httpStatus": 200,
          "apiVersionName": "v1",
          "isPayloadExist": true,
          "__typename": "AnalyticsStatsLog"
        }
      ],

      "__typename": "AnalyticsStatsLogsConnection"
    }
  }
}
```

--------------------------------

### Node.js example for user query

Source: https://docs.rapidapi.com/docs/graphql-platform-api-examples-users-teams-and-roles

Node.js implementation using axios to POST the GraphQL query. Replace placeholders for URL, API key, and host from sample code.

```JavaScript
const axios = require("axios");

const options = {
  method: "POST",
  url: "YOUR URL FROM SAMPLE CODE",
  headers: {
    "content-type": "application/json",
    "X-RapidAPI-Key": "YOUR KEY FROM SAMPLE CODE",
    "X-RapidAPI-Host": "YOUR HOST FROM SAMPLE CODE",
  },
  data: {
    query: `query Users($where: UserWhereInput!) {
  users(where: $where) {
    nodes {
      id
      username
      name
      email
      createdAt
      status
      Teams{
        id
        name
      }
    }
  }
}`,
    variables: { where: { email: "USER_EMAIL" } },
  },
};

axios
  .request(options)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.error(error);
  });
```

--------------------------------

### Query tutorials by API ID and version ID

Source: https://docs.rapidapi.com/docs/papi-gql-examples-api-documentation

Use this GraphQL query to read an API's tutorials. Requires the API ID and version ID as variables.

```GraphQL
query tutorials($id: ID!, $versionId: ID!) {
  tutorials(where: { apiId: $id, apiVersion: $versionId }) {
    nodes {
      id
      slugifiedName
      published
      title
      content
      thumbnailURL
      publishedDate
      readTime
      __typename
    }
    __typename
  }
}
```

```JSON
{
  "id": "api_b766b545-cd34-4b8a-8ec9-0e994cf6ed80",
  "versionId": "apiversion_1de8cd3a-94ec-45f0-b193-8d6f9a04dcd4"
}
```

--------------------------------

### x-badges array example

Source: https://docs.rapidapi.com/docs/adding-and-updating-openapi-documents

Example of the x-badges array in the info object of an OpenAPI document. Each badge is an object with name and value fields. If not defined, defaults to an empty array. Required tags may cause validation errors if missing.

```JSON
"x-badges": [
  {
    "name": "API Type",
    "value": "REST"
  },
  {
    "name": "Region",
    "value": "Global"
  }
]
```

--------------------------------

### getAppsForAnyUserGQL.js - GraphQL and REST Platform API example

Source: https://docs.rapidapi.com/docs/example-reading-a-users-apps-and-authorizations-graphql

Main script that reads a user's apps and authorizations using GraphQL and REST Platform APIs. Requires config.json in the same directory with admin_user_id, useremail, key, and host URLs. Set reportStatsToConsole to true for detailed timing and call counts.

```javascript
const reportStatsToConsole = true;
let totalRestAPICalls = 0;
let totalTimeOnRestCalls = 0;
let totalGQLAPICalls = 0;
const axios = require("axios").default;

let optionsCommonRest;
let optionsCommonGql;

let userKeyCache = {};

let resultsLog = []; //used to log messages and a subset of the data obtained

// set specific user email address, Hub urls, key, category and preferences in config.json
let config = require("./config.json");

optionsCommonRest = {
  headers: {
    "x-rapidapi-host": config.rapidapi_host_rest,
    "x-rapidapi-key": config.key,
  },
};

optionsCommonGql = {
  method: "POST",
  url: config.base_url_gql,
  headers: {
    "x-rapidapi-host": config.rapidapi_host_gql,
    "x-rapidapi-key": config.key,
    "content-type": "application/json",
  },
};

runAll();

async function runAll() {
  console.log("working...");
  if (reportStatsToConsole) console.time("total execution time");
  if (reportStatsToConsole) console.time("getUserByEmail execution time");
  let results = {};
  results.aUser = await getUserByEmail(config.useremail, config.admin_user_id);
  if (results.aUser) {
    results.aUser.email = config.useremail;
    if (reportStatsToConsole) console.timeEnd("getUserByEmail execution time");
    if (reportStatsToConsole) console.log("userid: " + results.aUser.id);

    if (reportStatsToConsole)
      console.time("getAUsersTeamsAndAppsFromId execution time");
    results = await getAUsersTeamsAndAppsFromId(results);
    if (reportStatsToConsole)
      console.timeEnd("getAUsersTeamsAndAppsFromId execution time");

    if (reportStatsToConsole) console.time("team auths execution time");
    results = await getAuthorizationsForAllTeamApps(results);
    if (reportStatsToConsole) console.timeEnd("team auths execution time");

    if (reportStatsToConsole) console.time("personal auths execution time");
    results = await getAuthorizationsForAllPersonalApps(results);
    if (reportStatsToConsole) console.timeEnd("personal auths execution time");

    logResults(results);
    if (reportStatsToConsole) console.timeEnd("total execution time");
    if (reportStatsToConsole)
      console.log(
        `total time on REST calls: ${Math.round(totalTimeOnRestCalls) / 1000}s`
      );
    if (reportStatsToConsole)
      console.log(`total number of REST calls: ${totalRestAPICalls}`);
    if (reportStatsToConsole)
      console.log(`total number GQL calls: ${totalGQLAPICalls}`);
  } else {
    resultsLog.push(`User ${config.useremail} not found!`);
    displayResultsLog();
  }
}

async function getUserByEmail(email, adminUserId) {
  totalGQLAPICalls++;
  const optionsUnique = {
    data: {
      query: `query Users($where: UserWhereInput!) {
        users(where: $where) {
            id
            username
            name
            email
          }
      }`,
      variables: {
        where: {
          email: email,
        },
      },
    },
  };
  const optionsCommonClone = JSON.parse(JSON.stringify(optionsCommonGql)); // deep clone
  let options = { ...optionsCommonClone, ...optionsUnique };
  options = await transformOptionsForOnBehalfOf(options, adminUserId, "user");

  let response = await axios.request(options);
  return response?.data?.data?.users[0];
}
```

--------------------------------

### General OAS extension fields example (x-category, x-long-description, etc.)

Source: https://docs.rapidapi.com/docs/adding-and-updating-openapi-documents

Shows the naming convention for fields that may be generally relevant outside of RapidAPI. These fields use the 'x-{{field}}' pattern and include examples like x-category, x-long-description, x-website, and x-public.

```JSON
"x-category": "Other",
"x-long-description": "This is the LONG description",
"x-website": "https://rapidapi.com",
"x-public": true,
 ...
```

--------------------------------

### Configuration File (config.json)

Source: https://docs.rapidapi.com/docs/example-using-the-rest-platform-api-listing-all-apis

Configuration file for the REST Platform API example. The first three fields (rapidapi_host, key, base_url) can be obtained from a code snippet when testing an endpoint. The key must have Environment Access to the REST Platform API because the code uses the on-behalf-of header.

```json
{
    "rapidapi_host": "YOURVALUE.YOURVALUE.rapidapi.com",
    "key": "YOURVALUE",
    "base_url": "https://YOURVALUE.p.rapidapi.com/v1/",
    "displayUserAPIs": true,
    "displayTeamAPIs": true,
    "displayPublicAPIs": true,
    "displayPrivateAPIs": true,
    "displayCategory": "Other",
    "helpForDisplayCategoryField": "enter 'all' above to display APIs from all categories"
}
```
Tokens:
Raw