### Start an Audit (Shell)

Source: https://api-docs.observepoint.com/index.html.md

This example demonstrates how to initiate a new audit run for a specified audit using a cURL POST request. An API key and the audit ID are required for this operation.

```shell
curl -X POST \
  -H 'Authorization: api_key YOUR_API_KEY_HERE' \
  https://api.observepoint.com/v2/web-audits/YOUR_AUDIT_ID_HERE/runs
```

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

### Get Audited Pages (Shell)

Source: https://api-docs.observepoint.com/index.html.md

This example shows how to fetch a paginated list of audited pages for a specific audit run using a cURL GET request. You need to provide your API key, audit ID, and run ID. The response is limited by the 'size' parameter.

```shell
curl -X GET \
  -H 'Authorization: api_key YOUR_API_KEY_HERE' \
  https://api.observepoint.com/v3/web-audits/YOUR_AUDIT_ID_HERE/runs/YOUR_RUN_ID_HERE/reports/page-summary/pages?size=100&page=0
```

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

### Get All Web Audits (Shell)

Source: https://api-docs.observepoint.com/index.html.md

This example demonstrates how to retrieve all web audits associated with your ObservePoint account using a cURL GET request. It requires an API key for authorization.

```shell
curl -X GET \
  -H 'Authorization: api_key YOUR_API_KEY_HERE' \
  https://api.observepoint.com/v3/web-audits
```

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

### GET /v3/schedules/presets

Source: https://api-docs.observepoint.com/_bundle/openapi/DATA-COLLECTION-API.openapi.json?download=

Retrieves all available schedule presets.

```APIDOC
## GET /v3/schedules/presets

### Description
Get all schedule presets.

### Method
GET

### Endpoint
/v3/schedules/presets

### Response
#### Success Response (200)
* **schedulePresets** (array) - An array of schedule preset objects.

#### Response Example
```json
[
  {
    "id": "daily",
    "name": "Daily Schedule",
    "description": "Runs every day."
  }
]
```
```

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

### Get Audit Configuration

Source: https://api-docs.observepoint.com/sections/api-recipes/update-starting-urls.md

Retrieve the current configuration of an existing audit, including its starting URLs, by making a GET request to the specified endpoint.

```APIDOC
## GET /v2/web-audits/{auditId}

### Description
Retrieves the full current configuration of a specified audit, including its starting URLs.

### Method
GET

### Endpoint
/v2/web-audits/{auditId}

#### Path Parameters
- **auditId** (integer) - Required - The ID of the audit to retrieve.

### Response
#### Success Response (200)
- **name** (string) - The name of the audit.
- **startingUrls** (array of strings) - An array of the current starting URLs for the audit.
- **id** (integer) - The ID of the audit.

#### Response Example
```json
{
  "name": "My Audit Name",
  "startingUrls": [
    "https://example.com/page1",
    "https://example.com/page2"
  ],
  "id": 1390894
}
```
```

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

### POST /live-connect-runs

Source: https://api-docs.observepoint.com/_bundle/openapi/SCALA-API.openapi.yaml?download=

Initializes a live connect run using provided HAR file data.

```APIDOC
## POST /live-connect-runs

### Description
Creates a live connect run based on provided HAR file information.

### Method
POST

### Endpoint
/live-connect-runs

### Request Body
- **journeyRunName** (string) - Optional - Name for the run
- **webhookUrl** (string) - Optional - Webhook URL for notifications

### Request Example
{
  "journeyRunName": "Live Run 001",
  "webhookUrl": "https://hooks.example.com/run"
}

### Response
#### Success Response (200)
- **runId** (integer) - The ID of the initialized run
- **name** (string) - The name of the run

#### Response Example
{
  "runId": 5001,
  "name": "Live Run 001"
}
```

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

### Get All Configured Devices (API)

Source: https://api-docs.observepoint.com/sections/api-recipes/create-liveconnect-journey.md

Retrieves a list of all configured devices for your account, essential for obtaining the device ID needed to start a LiveConnect session. This is a GET request to the /v2/manual-journeys endpoint.

```json
[
  {
    "...": "...",
    "id": 123,
    "...": "..."
  }
]
```

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

### GET /v3/usage/overview

Source: https://api-docs.observepoint.com/openapi/combined.openapi

Retrieves a brief usage overview for the current account.

```APIDOC
## GET /v3/usage/overview

### Description
Get brief usage overview for account.

### Method
GET

### Endpoint
/v3/usage/overview

### Response
#### Success Response (200)
- **usage** (object) - Account usage metrics.

#### Response Example
{
  "totalUsage": 1000,
  "limit": 5000
}
```

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

### GET /v3/schedules/calendar

Source: https://api-docs.observepoint.com/_bundle/openapi/DATA-COLLECTION-API.openapi.json?download=

Calculates and retrieves future occurrences of scheduled items based on provided start and end dates. This endpoint is crucial for planning and visualizing schedules.

```APIDOC
## GET /v3/schedules/calendar

### Description
Calculates future occurrences based on schedules and frequencies for a given date range.

### Method
GET

### Endpoint
/v3/schedules/calendar

### Parameters
#### Path Parameters
None

#### Query Parameters
- **localStartDateTime** (string) - Required - The start date and time in local format.
- **localEndDate** (string) - Required - The end date in local format.

#### Request Body
None

### Request Example
```
GET /v3/schedules/calendar?localStartDateTime=2023-10-27T10:00:00&localEndDate=2023-11-30
```

### Response
#### Success Response (200)
- **Array of ScheduledItem objects**: A list of scheduled items with their future occurrences.

#### Response Example
```json
[
  {
    "scheduleId": "schedule-abc",
    "occurrence": "2023-10-28T09:00:00"
  }
]
```

#### Error Responses
- **400**: Bad Request
- **401**: Unauthorized
- **403**: Forbidden
```

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

### POST /v2/manual-journeys/{manualJourneyId}

Source: https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys.md

Initializes a run for a specific manual journey.

```APIDOC
## POST /v2/manual-journeys/{manualJourneyId}

### Description
Initializes a run for a specific manual journey, preparing it for execution.

### Method
POST

### Endpoint
/v2/manual-journeys/{manualJourneyId}

### Parameters
#### Path Parameters
- **manualJourneyId** (string) - Required - The unique identifier of the manual journey to initialize.

### Response
#### Success Response (200)
- **runId** (string) - The identifier for the newly initialized journey run.
- **status** (string) - The initial status of the run (e.g., 'initializing').

#### Response Example
```json
{
  "runId": "run-abc",
  "status": "initializing"
}
```
```

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

### Run Audit Now

Source: https://api-docs.observepoint.com/_bundle/openapi/DATA-COLLECTION-API.openapi.json?download=

Initiates an audit run with specified parameters, including callback information.

```APIDOC
## POST /websites/api-docs_observepoint/AuditRun_RunNowRequestDTO

### Description
Starts an audit run immediately. This endpoint can also trigger a callback workflow upon completion.

### Method
POST

### Endpoint
/websites/api-docs_observepoint/AuditRun_RunNowRequestDTO

### Parameters
#### Request Body
- **startingUrls** (array[string]) - Optional - An array of URLs to start the audit from. If not provided, the system may use default starting URLs or those configured for the rule.
- **callbackWorkflowEventType** (string) - Required - The name of the workflow event to trigger upon audit completion (e.g., "audit-complete"). Do not include the file extension (e.g., ".yml").
- **callbackRepositoryOwner** (string) - Required - The owner of the GitHub repository where the callback workflow is defined.
- **callbackRepositoryName** (string) - Required - The name of the GitHub repository where the callback workflow is defined.
- **callbackContext** (object) - Optional - An object containing context data to be passed to the callback workflow.
- **maxPages** (integer) - Optional - The maximum number of pages to scan during the audit. If not provided, it defaults to a value based on the starting URLs and audit configuration limits.
- **ghAppName** (string) - Optional - The GitHub App to use for dispatching the callback workflow. Defaults to "observepoint-integration" if not specified.

### Request Example
```json
{
  "startingUrls": [
    "https://www.example.com"
  ],
  "callbackWorkflowEventType": "audit-complete",
  "callbackRepositoryOwner": "my-org",
  "callbackRepositoryName": "my-repo",
  "callbackContext": {
    "data": "some-value"
  },
  "maxPages": 100,
  "ghAppName": "observepoint-integration"
}
```

### Response
#### Success Response (200)
- **AuditRun_RunNowResponseDTO** (object) - Details about the initiated audit run.

#### Response Example
{
  "auditRunId": "ar-12345",
  "status": "Running"
}
```

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

### POST /v2/folders

Source: https://api-docs.observepoint.com/_bundle/openapi/SCALA-API.openapi.yaml?download=

Creates a new folder.

```APIDOC
## POST /v2/folders

### Description
Creates a new folder with the provided information.

### Method
POST

### Endpoint
/v2/folders

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new folder.

### Request Example
```json
{
  "name": "New Project Folder"
}
```

### Response
#### Success Response (201)
- **folder** (object) - The newly created Folder object.

#### Response Example
```json
{
  "folderId": 2,
  "name": "New Project Folder",
  "createdAt": "2023-10-27T11:00:00Z"
}
```

#### Error Responses
- **401**: Authentication credentials are missing or invalid.
```

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

### Get Network Request Inventory (JavaScript)

Source: https://api-docs.observepoint.com/sections/grid-api-examples/all-network-requests.md

Retrieves a network request inventory from recent page scans using the ObservePoint Grid API. This snippet demonstrates the POST request structure, including columns to retrieve and filters for recent scans and runs. It requires the API endpoint and a JSON payload.

```javascript
POST https://api.observepoint.com/v3/reports/grid/network-requests
{
  "columns": [
    { "columnId": "REQUEST_URL" },
    { "columnId": "REQUEST_RESOURCE_TYPE" },
    { "columnId": "REQUEST_STATUS_CODE" },
    { "columnId": "REQUEST_COUNTRY_CODE" },
    { "columnId": "REQUEST_NETWORK_ERROR" },
    { "columnId": "REQUEST_METHOD" },
    { "columnId": "REQUEST_SERVER_IP_ADDRESS" },
    { "columnId": "REQUEST_HTTP_VERSION" },
    { "columnId": "RESPONSE_CONTENT_SIZE" },
    { "columnId": "RESPONSE_CONTENT_MIME_TYPE" },
    { "columnId": "RESPONSE_CONTENT_ENCODING" },
    { "columnId": "RESPONSE_LAST_MODIFIED" },
    { "columnId": "COOKIES_SET" }
  ],
  "filters": {
    "conditionMatchMode": "all",
    "conditions": [
      {
        "args": [1],
        "negated": false,
        "operator": "integer_in",
        "filteredColumn": { "columnId": "IS_MOST_RECENT_PAGE_SCAN" }
      },
      {
        "args": [1],
        "negated": false,
        "operator": "integer_in",
        "filteredColumn": { "columnId": "IS_MOST_RECENT_RUN" }
      },
      {
        "startDuration": 30,
        "startUnit": "day",
        "negated": false,
        "operator": "date_time_relative",
        "filteredColumn": { "columnId": "ABSOLUTE_PAGE_VISIT_START_TIME" }
      }
    ],
    "allAccounts": false
  },
  "sortBy": [],
  "page": 0,
  "size": 10000
}
```

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

### Run Audit Now

Source: https://api-docs.observepoint.com/_bundle/openapi/DATA-COLLECTION-API.openapi.json?download=

Initiates an immediate run of a specified web audit.

```APIDOC
## POST /v3/web-audits/{auditId}/runs

### Description
Run a web audit now.

### Method
POST

### Endpoint
/v3/web-audits/{auditId}/runs

### Parameters
#### Path Parameters
- **auditId** (string) - Required - The ID of the audit to run.

### Response
#### Success Response (200)
- (No specific response schema provided in the input, assuming a success indicator or run details)

#### Response Example
```json
{
  "message": "Audit run initiated successfully.",
  "runId": "run-12345"
}
```
```

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

### POST /v3/action-sets

Source: https://api-docs.observepoint.com/openapi/combined.openapi/action-sets/createactionset

Creates a new action set with a specified name and a list of actions.

```APIDOC
## POST /v3/action-sets

### Description
Create a new action set.

### Method
POST

### Endpoint
/v3/action-sets

### Query Parameters
- **accountId** (integer) - Required - Account ID to create action set in

### Request Body
- **name** (string) - Required - Name of the action set
- **actions** (array) - Required - List of actions in the action set
  - **actions.sequence** (integer) - Required - Sequence number of the action
  - **actions.description** (string) - Optional - Description of the action. Present for all actionTypes except: actionSet
  - **actions.actionType** (string) - Required - Type of the user action. Enum: "click", "input", "maskedinput", "select", "check", "uncheck", "enteriframe", "navto", "watch", "clearcookies", "execute", "exitiframe", "privacyoptin", "privacyoptout", "actionset"
  - **actions.waitDuration** (integer) - Optional - Duration to wait in milliseconds. Present for actionTypes: navTo, click, input, select, check, uncheck, execute, watch, maskedInput, enterIFrame, exitIFrame, clearCookies, privacyOptIn, privacyOptOut
  - **actions.selectors** (array) - Optional - List of selectors for element-based actions. Present for actionTypes: click, input, select, check, uncheck, maskedInput, enterIFrame
    - **actions.selectors.selectorType** (string) - Required - Enum: "id", "name", "css", "xpath", "htmlattributes"
    - **actions.selectors.value** (any) - Required - Selector value - string for simple selectors (CSS, XPath, id, name) or AttributeSelectorValue object for htmlattributes selector type
  - **actions.preventNavigation** (boolean) - Optional - Whether to prevent navigation after action execution. Present for actionTypes: click, input, select, check, uncheck, execute, watch, maskedInput
  - **actions.value** (string) - Optional - Value field with different meanings per actionType. For input/select: input value. For navTo: URL. For privacyOptIn/privacyOptOut: URL. For execute: JavaScript code. Present for actionTypes: input, select, navTo, privacyOptIn, privacyOptOut, execute
  - **actions.maskedValue** (string) - Optional - Masked value for secure input actions. Present for actionType: maskedInput
  - **actions.js** (string) - Optional - JavaScript code to execute. Present for actionType: execute
  - **actions.url** (string) - Optional - URL for navigation and privacy actions. Present for actionTypes: navTo, privacyOptIn, privacyOptOut
  - **actions.seconds** (integer) - Optional - Number of seconds to watch/wait. Present for actionType: watch
  - **actions.isRequired** (boolean) - Optional - Whether privacy action is required. Present for actionTypes: privacyOptIn, privacyOptOut
  - **actions.actionSetId** (integer) - Optional - ID of the action set this action belongs to. For actionType 'actionSet', this contains the referenced action set ID
  - **actions.pageFilter** (string) - Optional - Page filter pattern for the action

### Request Example
{
  "name": "Example Action Set",
  "actions": [
    {
      "sequence": 1,
      "actionType": "click",
      "description": "Click the login button",
      "selectors": [
        {
          "selectorType": "css",
          "value": "#login-button"
        }
      ]
    },
    {
      "sequence": 2,
      "actionType": "input",
      "description": "Enter username",
      "selectors": [
        {
          "selectorType": "id",
          "value": "username"
        }
      ],
      "value": "testuser"
    }
  ]
}

### Response
#### Success Response (200)
- **id** (integer) - The ID of the created action set.
- **name** (string) - The name of the action set.
- **actions** (array) - The list of actions in the action set.

#### Response Example
{
  "id": 123,
  "name": "Example Action Set",
  "actions": [
    {
      "sequence": 1,
      "actionType": "click",
      "description": "Click the login button",
      "selectors": [
        {
          "selectorType": "css",
          "value": "#login-button"
        }
      ]
    },
    {
      "sequence": 2,
      "actionType": "input",
      "description": "Enter username",
      "selectors": [
        {
          "selectorType": "id",
          "value": "username"
        }
      ],
      "value": "testuser"
    }
  ]
}
```

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

### Retrieve Saved Report Configuration using Report ID

Source: https://api-docs.observepoint.com/sections/grid-api-examples/use-saved-report-configruation.md

Fetches the configuration of a saved report from ObservePoint using its unique report ID. This involves making a GET request to the specified API endpoint. The response includes essential details like the report's name, entity type, and its query definition.

```text
GET https://api.observepoint.com/v3/reports/grid/saved/12345
```

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

### GET /v2/tags

Source: https://api-docs.observepoint.com/openapi/scala-api.openapi/tags.md

Retrieves a list of all available tags. This endpoint is useful for getting an overview of all tags in the system.

```APIDOC
## GET /v2/tags

### Description
Returns all tags.

### Method
GET

### Endpoint
/v2/tags

### Parameters

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **tags** (array) - A list of tag objects.
  - **id** (string) - The unique identifier for the tag.
  - **name** (string) - The name of the tag.
  - **description** (string) - A description of the tag.

#### Response Example
```json
{
  "tags": [
    {
      "id": "tag123",
      "name": "Production",
      "description": "Tags for production environment"
    },
    {
      "id": "tag456",
      "name": "Staging",
      "description": "Tags for staging environment"
    }
  ]
}
```
```

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

### POST /v2/folders

Source: https://api-docs.observepoint.com/openapi/scala-api.openapi/folders.md

Creates a new folder within the system.

```APIDOC
## POST /v2/folders

### Description
Creates a new folder.

### Method
POST

### Endpoint
/v2/folders

### Request Body
- **name** (string) - Required - The name of the new folder.

### Request Example
{
  "name": "New Folder"
}
```

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

### POST /v3/alerts

Source: https://api-docs.observepoint.com/openapi/combined.openapi.md

Creates a new alert configuration within the system.

```APIDOC
## POST /v3/alerts

### Description
Creates a new alert configuration.

### Method
POST

### Endpoint
/v3/alerts

### Request Body
- **name** (string) - Required - The name of the alert
- **conditions** (object) - Required - The criteria for triggering the alert

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the created alert
```

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

### GET /v2/rules/previews

Source: https://api-docs.observepoint.com/_bundle/openapi/SCALA-API.openapi.yaml?download=

Retrieves a list of rule preview objects. This endpoint is useful for getting an overview of available rules before detailed inspection.

```APIDOC
## GET /v2/rules/previews

### Description
Get a list of rule preview objects. This endpoint provides a summary of rules.

### Method
GET

### Endpoint
/v2/rules/previews

### Parameters
#### Query Parameters
None

#### Path Parameters
None

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **items** (array) - An array of RulePreview objects.

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string",
    "description": "string"
  }
]
```

#### Error Response (401)
- **message** (string) - Authentication credentials are missing or invalid.
```

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

### GET /v3/web-journeys/{webJourneyId}/runs/{runId}/status

Source: https://api-docs.observepoint.com/_bundle/openapi/DATA-COLLECTION-API.openapi.json?download=

Get the status of a specific web journey run. This endpoint provides information about the execution status of a particular run.

```APIDOC
## GET /v3/web-journeys/{webJourneyId}/runs/{runId}/status

### Description
Get the status of a specific web journey run.

### Method
GET

### Endpoint
/v3/web-journeys/{webJourneyId}/runs/{runId}/status

### Parameters
#### Path Parameters
- **webJourneyId** (integer) - Required - The ID of the web journey
- **runId** (integer) - Required - The ID of the web journey run

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - The status of the web journey run (e.g., "running", "completed", "failed").

#### Response Example
```json
{
  "status": "completed"
}
```
```

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

### POST /v3/site-censuses/{censusId}/start

Source: https://api-docs.observepoint.com/_bundle/openapi/DATA-COLLECTION-API.openapi.json?download=

Initiates data collection for a specific site census.

```APIDOC
## POST /v3/site-censuses/{censusId}/start

### Description
Starts the data-collection process for the specified census.

### Method
POST

### Endpoint
/v3/site-censuses/{censusId}/start

### Parameters
#### Path Parameters
- **censusId** (string) - Required - The ID of the site census to start.

### Response
#### Success Response (200)
- **status** (string) - The updated status of the census.

#### Response Example
{
  "id": "123",
  "status": "running"
}
```

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

### POST /v2/manual-journeys

Source: https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys.md

Creates a new manual journey.

```APIDOC
## POST /v2/manual-journeys

### Description
Creates a new manual journey.

### Method
POST

### Endpoint
/v2/manual-journeys

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new manual journey.
- **description** (string) - Optional - A description for the new manual journey.

### Request Example
```json
{
  "name": "New Product Launch Test",
  "description": "Testing the user flow for the new product launch."
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the newly created manual journey.
- **name** (string) - The name of the manual journey.
- **description** (string) - The description of the manual journey.
- **createdAt** (string) - The timestamp when the journey was created.
- **updatedAt** (string) - The timestamp when the journey was last updated.

#### Response Example
```json
{
  "id": "journey-456",
  "name": "New Product Launch Test",
  "description": "Testing the user flow for the new product launch.",
  "createdAt": "2023-10-27T11:00:00Z",
  "updatedAt": "2023-10-27T11:00:00Z"
}
```
```

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

### GET /domains/{domainId}/web-audits

Source: https://api-docs.observepoint.com/_bundle/openapi/SCALA-API.openapi.yaml?download=

Retrieves web audits associated with a specific domain. This endpoint is used to get a list of web audits for a given domain ID.

```APIDOC
## GET /domains/{domainId}/web-audits

### Description
Retrieves web audits associated with a specific domain.

### Method
GET

### Endpoint
/v2/domains/{domainId}/web-audits

### Parameters
#### Path Parameters
- **domainId** (integer) - Required - The ID of the domain for which to retrieve web audits.

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **WebAudits** (array) - A list of web audit objects.

#### Response Example
```json
{
  "example": "list of web audits"
}
```

#### Error Response (401)
- **Authentication credentials are missing or invalid**
#### Error Response (404)
- **Requested item not found**
```

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

### Start Audit Run

Source: https://api-docs.observepoint.com/sections/api-recipes/update-starting-urls.md

Initiate a new run for a specified audit by making a POST request to the audit runs endpoint.

```APIDOC
## POST /v2/web-audits/{auditId}/runs

### Description
Starts a new audit run for a given audit.

### Method
POST

### Endpoint
/v2/web-audits/{auditId}/runs

#### Path Parameters
- **auditId** (integer) - Required - The ID of the audit to start a run for.

### Request Body
This endpoint accepts an empty payload.

### Response
#### Success Response (200 or 201)
Indicates that the audit run has been successfully initiated.
```

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

### Update Audit Configuration

Source: https://api-docs.observepoint.com/sections/api-recipes/update-starting-urls.md

Update an existing audit's configuration, specifically its starting URLs, by sending a PUT request with the modified audit object.

```APIDOC
## PUT /v2/web-audits/{auditId}

### Description
Updates an existing audit with a new configuration. This is commonly used to change the `startingUrls` and optionally the `limit`.

### Method
PUT

### Endpoint
/v2/web-audits/{auditId}

#### Path Parameters
- **auditId** (integer) - Required - The ID of the audit to update.

#### Request Body
- **startingUrls** (array of strings) - Required - The new array of valid URL strings for the audit.
- **limit** (integer) - Optional - The maximum number of URLs to visit. Setting this to the number of `startingUrls` ensures only those pages are crawled.

### Request Example
```json
{
  "startingUrls": [
    "https://example.com/page3",
    "https://example.com/page4"
  ],
  "limit": 2
}
```

### Response
#### Success Response (200)
Indicates the audit was successfully updated. The response body typically contains the updated audit configuration.

#### Error Response (422)
Returned if any of the specified `startingUrls` are invalid. The audit will not be updated.
```

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

### POST /v2/manual-journeys

Source: https://api-docs.observepoint.com/openapi/scala-api.openapi

Creates a new manual journey configuration within the ObservePoint platform.

```APIDOC
## POST /v2/manual-journeys

### Description
Creates a new manual journey for testing purposes.

### Method
POST

### Endpoint
/v2/manual-journeys

### Request Body
- **name** (string) - Required - The name of the manual journey.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the created manual journey.
```

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

### Run Audit Now

Source: https://api-docs.observepoint.com/openapi/data-collection-api.openapi

Initiates an immediate run for a specified audit.

```APIDOC
## POST /v3/web-audits/{auditId}/runs

### Description
Run an audit now.

### Method
POST

### Endpoint
/v3/web-audits/{auditId}/runs

### Parameters
#### Path Parameters
- **auditId** (string) - Required - The ID of the audit to run.

### Request Body
(Schema not provided in source text)

### Response
(Schema not provided in source text)
```

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

### GET /v3/usage/overview

Source: https://api-docs.observepoint.com/openapi/combined.openapi/account-usage-v2/getaccountusagev2overview

Fetches a comprehensive overview of your account's usage for audits and web journeys. This includes current usage counts, limits, contract term dates, and information about overage charges.

```APIDOC
## GET /v3/usage/overview

### Description
Retrieves a brief usage overview for the account, including audit and web journey usage details, limits, and overage information.

### Method
GET

### Endpoint
/v3/usage/overview

### Parameters
#### Query Parameters
None

#### Path Parameters
None

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **auditUsage** (object, required) - Usage details for audits.
  - `usageCount` (integer, required) - Number of pages scanned (for audits) or runs completed (for web journeys) to date.
  - `usageLimit` (integer) - Limit of pages scanned (for audits) or runs completed (for web journeys) for the current contract term. Can be omitted if there is no limit.
  - `limitNoteType` (string) - Indicates the type of limit. Enum: "UNLIMITED", "LIMIT_UNDETERMINED".
  - `usagePercentage` (number) - Percentage of usage relative to the contract term limit. Can be omitted if there is no limit.
  - **overLimitPrice** (object) - Price of a page scan (for audits) or a run (for web journeys) over the limit. Only visible to account admins.
    - `amount` (number, required) - Example: 0.01
    - `currency` (string, required) - A currency represented by its ISO 4217 alpha code. Example: "USD"
  - **currentContractTerm** (object, required) - Contract start and end dates.
    - `startDateInclusive` (string, required) - Date in ISO 8601 format, in UTC timezone.
    - `endDateInclusive` (string, required) - Date in ISO 8601 format, in UTC timezone.
- **webJourneyUsage** (object) - Usage details for web journeys.
  - `usageCount` (integer, required) - Number of pages scanned (for audits) or runs completed (for web journeys) to date.
  - `usageLimit` (integer) - Limit of pages scanned (for audits) or runs completed (for web journeys) for the current contract term. Can be omitted if there is no limit.
  - `limitNoteType` (string) - Indicates the type of limit. Enum: "UNLIMITED", "LIMIT_UNDETERMINED".
  - `usagePercentage` (number) - Percentage of usage relative to the contract term limit. Can be omitted if there is no limit.
  - **overLimitPrice** (object) - Price of a page scan (for audits) or a run (for web journeys) over the limit. Only visible to account admins.
    - `amount` (number, required) - Example: 0.01
    - `currency` (string, required) - A currency represented by its ISO 4217 alpha code. Example: "USD"
  - **currentContractTerm** (object, required) - Contract start and end dates.
    - `startDateInclusive` (string, required) - Date in ISO 8601 format, in UTC timezone.
    - `endDateInclusive` (string, required) - Date in ISO 8601 format, in UTC timezone.
- **allowOverages** (boolean, required) - When TRUE, the account is allowed to go over the limit and will be charged for overages. When FALSE, the account will be blocked from running audits and web journeys that will go over the limit.

#### Response Example (200 OK)
```json
{
  "auditUsage": {
    "usageCount": 150,
    "usageLimit": 200,
    "limitNoteType": "LIMIT_UNDETERMINED",
    "usagePercentage": 75,
    "overLimitPrice": {
      "amount": 0.01,
      "currency": "USD"
    },
    "currentContractTerm": {
      "startDateInclusive": "2023-01-01T00:00:00Z",
      "endDateInclusive": "2023-12-31T23:59:59Z"
    }
  },
  "webJourneyUsage": {
    "usageCount": 80,
    "usageLimit": 100,
    "limitNoteType": "LIMIT_UNDETERMINED",
    "usagePercentage": 80,
    "overLimitPrice": {
      "amount": 0.015,
      "currency": "USD"
    },
    "currentContractTerm": {
      "startDateInclusive": "2023-01-01T00:00:00Z",
      "endDateInclusive": "2023-12-31T23:59:59Z"
    }
  },
  "allowOverages": true
}
```

#### Error Response (401 Unauthorized)
- **timestamp** (string)
- **message** (string)
- **details** (string)
- **validationReport** (object)

#### Response Example (401 Unauthorized)
```json
{
  "timestamp": "2023-10-27T10:00:00Z",
  "message": "Authentication failed.",
  "details": "Invalid API key provided.",
  "validationReport": {}
}
```

#### Error Response (403 Forbidden)
- **timestamp** (string)
- **message** (string)
- **details** (string)
- **validationReport** (object)

#### Response Example (403 Forbidden)
```json
{
  "timestamp": "2023-10-27T10:05:00Z",
  "message": "Access denied.",
  "details": "User does not have permission to access this resource.",
  "validationReport": {}
}
```
```

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

### GET /v2/tags

Source: https://api-docs.observepoint.com/_bundle/openapi/SCALA-API.openapi.yaml?download=

Retrieves a list of all available tags.

```APIDOC
## GET /v2/tags

### Description
Returns a collection of all tags defined in the system.

### Method
GET

### Endpoint
/v2/tags

### Response
#### Success Response (200)
- **Tag[]** (array) - List of tags.
```

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

### GET /v2/labels

Source: https://api-docs.observepoint.com/openapi/scala-api.openapi.md

Retrieves a list of all available labels.

```APIDOC
## GET /v2/labels

### Description
Gets a list of all labels.

### Method
GET

### Endpoint
/v2/labels

### Parameters
(No parameters for this endpoint)

### Request Example
(No request body for GET operations)

### Response
#### Success Response (200)
- **labels** (array) - A list of label objects.
  - **labelId** (string) - The unique identifier of the label.
  - **labelName** (string) - The name of the label.

#### Response Example
{
  "labels": [
    {
      "labelId": "l1",
      "labelName": "Urgent"
    },
    {
      "labelId": "l2",
      "labelName": "Bug"
    }
  ]
}
```

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

### POST /v3/remote-file-mappings

Source: https://api-docs.observepoint.com/openapi/data-collection-api.openapi/remote-file-mappings/createremotefilemapping

Creates a new remote file mapping configuration for a specified account.

```APIDOC
## POST /v3/remote-file-mappings

### Description
Create a new remote file mapping configuration to intercept and replace request URLs.

### Method
POST

### Endpoint
/v3/remote-file-mappings

### Parameters
#### Query Parameters
- **accountId** (integer) - Required - Account ID to create the mapping for

#### Request Body
- **name** (string) - Required - A user-supplied name to identify this RFM config
- **fileId** (string) - Optional - A string GUID used as the uploaded replacement file's "name" in S3
- **fileUrl** (string) - Optional - The replacement URL, or else the name of the replacement file before it was uploaded
- **matchType** (string) - Required - Either "regex" or "equals"
- **matchValue** (string) - Required - The request URL to be replaced (or the regex that matches URLs to replace)

### Request Example
{
  "name": "Google Analytics Replacement",
  "fileId": "8c59d02b-6ebc-4893-9391-9be26c6d34cc",
  "fileUrl": "https://example.com/replacement-script.js",
  "matchType": "equals",
  "matchValue": "https://www.google-analytics.com/analytics.js"
}

### Response
#### Success Response (200)
- **id** (integer) - Simple surrogate key in the database
- **name** (string) - User-supplied name
- **fileId** (string) - S3 file identifier
- **fileUrl** (string) - Replacement URL
- **matchType** (string) - Matching logic used
- **matchValue** (string) - URL or regex pattern
- **accountId** (integer) - Owner account ID
- **createdBy** (integer) - User ID of creator
- **createdAt** (string) - Creation timestamp
- **updatedBy** (integer) - User ID of last updater
- **updatedAt** (string) - Last update timestamp

#### Response Example
{
  "id": 123,
  "name": "Google Analytics Replacement",
  "fileId": "8c59d02b-6ebc-4893-9391-9be26c6d34cc",
  "fileUrl": "https://example.com/replacement-script.js",
  "matchType": "equals",
  "matchValue": "https://www.google-analytics.com/analytics.js",
  "accountId": 343,
  "createdBy": 1362,
  "createdAt": "2024-01-01T10:15:00.000Z",
  "updatedBy": 1362,
  "updatedAt": "2024-01-02T10:15:00.000Z"
}
```

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

### GET /v2/manual-journeys

Source: https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys.md

Retrieves a list of all manual journeys.

```APIDOC
## GET /v2/manual-journeys

### Description
Retrieves a list of all manual journeys.

### Method
GET

### Endpoint
/v2/manual-journeys

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of journeys to return.
- **offset** (integer) - Optional - The number of journeys to skip before starting to collect the result set.

### Response
#### Success Response (200)
- **journeys** (array) - A list of manual journey objects.
  - **id** (string) - The unique identifier for the manual journey.
  - **name** (string) - The name of the manual journey.
  - **description** (string) - A description of the manual journey.
  - **createdAt** (string) - The timestamp when the journey was created.
  - **updatedAt** (string) - The timestamp when the journey was last updated.

#### Response Example
```json
{
  "journeys": [
    {
      "id": "journey-123",
      "name": "Homepage Test",
      "description": "Test the main homepage functionality.",
      "createdAt": "2023-10-27T10:00:00Z",
      "updatedAt": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

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

### POST /v3/web-audits/{auditId}/runs

Source: https://api-docs.observepoint.com/openapi/data-collection-api.openapi/audits-management/runauditnow.md

Triggers an immediate execution of a specified web audit using the provided configuration parameters.

```APIDOC
## POST /v3/web-audits/{auditId}/runs

### Description
Triggers a new run for an existing web audit. Requires authentication via API Key.

### Method
POST

### Endpoint
/v3/web-audits/{auditId}/runs

### Parameters
#### Path Parameters
- **auditId** (integer) - Required - Unique identification number for the web audit.

#### Request Body
- **startingUrls** (array) - Optional - List of URLs to start the audit from.
- **callbackWorkflowEventType** (string) - Required - The workflow file name (without extension) to trigger upon completion.
- **callbackRepositoryOwner** (string) - Required - The owner of the repository containing the callback workflow.
- **callbackRepositoryName** (string) - Required - The name of the repository containing the callback workflow.
- **callbackContext** (object) - Optional - Context data for the callback URL.
- **maxPages** (integer) - Optional - Maximum number of pages to scan.
- **ghAppName** (string) - Optional - GitHub App to use for workflow dispatch. Enum: "observepoint-integration", "observepoint-test-app".

### Request Example
{
  "callbackWorkflowEventType": "audit-complete",
  "callbackRepositoryOwner": "my-org",
  "callbackRepositoryName": "my-repo",
  "maxPages": 100
}

### Response
#### Success Response (201)
- **status** (string) - Indicates successful initiation of the audit run.

#### Error Responses
- **400/401/403** (object) - Returns timestamp, message, details, and validationReport.
```

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

### Retrieve Audit Configuration via REST API

Source: https://api-docs.observepoint.com/sections/api-recipes/update-starting-urls.md

Fetches the current configuration of a specific audit by its ID. The response returns a JSON object containing the current starting URLs and other audit settings.

```http
GET https://api.observepoint.com/v2/web-audits/{auditId}
```

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

### POST /v2/rules

Source: https://api-docs.observepoint.com/_bundle/openapi/SCALA-API.openapi.yaml?download=

Creates a new rule configuration.

```APIDOC
## POST /v2/rules

### Description
Creates a new rule based on the provided configuration.

### Method
POST

### Endpoint
/v2/rules

### Parameters
#### Request Body
- **NewRule** (object) - Required - The rule creation data.

### Response
#### Success Response (201)
- **Rule** (object) - The created rule object.

#### Response Example
{
  "ruleId": 123,
  "name": "New Rule"
}
```

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

### GET /action-sets

Source: https://api-docs.observepoint.com/openapi/combined.openapi/action-sets/createactionset

Retrieves the structure and details of an action set, including the sequence of actions and their specific configurations.

```APIDOC
## GET /action-sets

### Description
Retrieves the details of an action set, including all associated user actions, their types, and configuration parameters.

### Method
GET

### Endpoint
/action-sets

### Parameters
None

### Request Example
{
  "actionSetId": 123
}

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier of the action set
- **name** (string) - Name of the action set
- **actions** (array) - List of actions in the set
- **actions.sequence** (integer) - Order of the action
- **actions.actionType** (string) - Type of action (e.g., click, input, navto)
- **updatedAt** (string) - Last update timestamp
- **createdAt** (string) - Creation timestamp

#### Response Example
{
  "id": 123,
  "name": "Login Flow",
  "actions": [
    {
      "sequence": 1,
      "actionType": "input",
      "value": "user@example.com"
    }
  ]
}
```