### Get Webhook Configurations

Source: https://api.bynder.com/reference/getwebhookconfigurations

This example shows how to retrieve all webhook configurations using a GET request.

```APIDOC
## Get Webhook Configurations

### Description
Retrieves a list of all configured webhooks for your Bynder instance.

### Method
GET

### Endpoint
/v7/webhooks/public/api/subscriptions

### Parameters
This endpoint does not accept any parameters.

### Request Example
(No request body is required for this GET request)

### Response
#### Success Response (200)
- **antivirusEnabled** (boolean) - Indicates if antivirus scanning is enabled.
- **configs** (array) - A list of webhook configuration objects.
  - **configId** (string) - The unique identifier for the webhook configuration.
  - **confirmed** (number) - Indicates if the webhook subscription is confirmed.
  - **endpoint** (string) - The URL or email address where webhook events will be sent.
  - **events** (array of strings) - A list of events the webhook is subscribed to.
  - **is_legacy** (boolean) - Indicates if the webhook configuration is legacy.
  - **migratedSubscriptions** (string) - Information about migrated subscriptions.
  - **name** (string) - The name of the webhook configuration.
  - **preArchivedNotificationDays** (number) - The number of days before pre-archiving to send notifications.
  - **protocol** (string) - The protocol used for the webhook (e.g., 'email').
  - **status** (number) - The status of the webhook configuration.
- **message** (string) - A message associated with the response.
- **success** (boolean) - Indicates if the request was successful.

#### Response Example
```json
{
  "antivirusEnabled": true,
  "configs": [
    {
      "configId": "cf2493be-c808-41da-bcc2-cfb31f38b457",
      "confirmed": 1,
      "endpoint": "example@example.com",
      "events": [
        "asset_bank.media.archived",
        "asset_bank.media.pre_archived",
        "asset_bank.media.deleted",
        "asset_bank.media.updated",
        "asset_bank.media.meta_updated",
        "asset_bank.media.create",
        "workflow.job.create",
        "antivirus.scan.failed"
      ],
      "is_legacy": false,
      "migratedSubscriptions": "[]",
      "name": "example-webhook-name",
      "preArchivedNotificationDays": 1,
      "protocol": "email",
      "status": 1
    }
  ],
  "message": "",
  "success": true
}
```
```

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

### Asset Create Event Example

Source: https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-create

This example demonstrates the structure of an asset.create event, which is triggered when a new asset is created.

```APIDOC
## GET /v7/analytics/api/v1/asset/create

### Description
Retrieves a list of asset creation events.

### Method
GET

### Endpoint
/v7/analytics/api/v1/asset/create

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of events to return.
- **offset** (integer) - Optional - The number of events to skip.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the event.
- **eventType** (string) - The type of event, which is 'asset.create'.
- **userId** (string) - The ID of the user who triggered the event.
- **dateTime** (string) - The timestamp when the event occurred.
- **assetId** (string) - The ID of the created asset.
- **assetType** (string) - The type of the created asset (e.g., 'image').
- **assetName** (string) - The name of the created asset.
- **assetAudit** (string) - The audit status of the asset (e.g., 'ACCEPTED').
- **fileName** (string) - The name of the file associated with the asset.

### Response Example
```json
[
  {
    "id": "62de6d714e29485a81824fe3",
    "eventType": "asset.create",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "assetId": "CA510292-E39E-4B28-AB6444CDD2B1C5C0",
    "assetType": "image",
    "assetName": "Product Insights",
    "assetAudit": "ACCEPTED",
    "fileName": "CA510292-E39E-4B28-AB6444CDD2B1C5C0___Product Insights"
  },
  {
    "id": "62de6d714e29485a81824fe4",
    "eventType": "asset.create",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "dateTime": "2021-11-15T10:08:18.752+00:00",
    "assetId": "C58ED8C6-6B09-4CD6-B71C32C6715834F1",
    "assetType": "image",
    "assetName": "Reporting Schedule Nov 2022",
    "assetAudit": "ACCEPTED",
    "fileName": "C58ED8C6-6B09-4CD6-B71C32C6715834F1___Reporting Schedule Nov 2022"
  }
]
```
```

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

### Example Response for Get Actions

Source: https://api.bynder.com/reference/getactions

This JSON object shows an example of the response when fetching available automation workflow actions. It includes a list of action types and the maximum limit for actions.

```json
{
  "actions": [
    {
      "action_type": "AGENT_ENRICHMENT"
    },
    {
      "action_type": "ADD_TO_COLLECTION"
    },
    {
      "action_type": "AGENT_TRANSFORMATION"
    },
    {
      "action_type": "AGENT_BRAND_COMPLIANCE"
    },
    {
      "action_type": "AGENT_GOVERNANCE"
    }
  ],
  "max_actions_limit": 5
}
```

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

### Example Asset Download Response

Source: https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-v2-download

This example demonstrates the structure of a successful response when requesting asset download analytics. It includes details for multiple download events.

```json
[
  {
    "eventId": "1408aec2-3114-43dd-be20-ffb1246a5231",
    "eventType": "AssetDownloadRequested",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "assetId": "CA510292-E39E-4B28-AB6444CDD2B1C5C0",
    "downloadReasons": [
      "reason1",
      "reason2"
    ]
  },
  {
    "eventId": "5908aec2-3114-43dd-be20-ffb1246a5231",
    "eventType": "AssetDownloadRequested",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "assetId": "C58ED8C6-6B09-4CD6-B71C32C6715834F",
    "downloadReasons": [
      "reason2"
    ]
  }
]

```

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

### Example Response: List of Dependencies

Source: https://api.bynder.com/reference/get_api-v4-metaproperties-id-options-optionid-dependencies-1

This example shows a successful response when retrieving metaproperty option dependencies. The response is a JSON array of strings, where each string is a dependency ID.

```json
[
  "00000000-0000-0000-0000000000000000",
  "00000000-0000-0000-0000000000000001"
]
```

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

### OpenAPI Definition Example

Source: https://api.bynder.com/reference/save-uploaded-file-to-existing-asset

This is an example of an OpenAPI definition.

```yaml
openapi: 3.0.0
info:
  title: API
  version: 1.0.0
paths:
  /example:
    get:
      summary: Example endpoint
      responses:
        '200':
          description: Successful response
servers:
  - url: http://localhost:3000
components:
  schemas:
    Example:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
security:
  - bearerAuth: []
```

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

### Example Response: Not Found

Source: https://api.bynder.com/reference/get_api-v4-metaproperties-id-options-optionid-dependencies-1

This example illustrates the response when the specified metaproperty or metaproperty option does not exist. It returns a JSON object with an error message and the corresponding status code.

```json
{
  "message": "Unknown metaproperty",
  "statuscode": "404"
}
```

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

### Example Asset Create Response

Source: https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-create

This example demonstrates the structure of a successful response when creating an asset. It includes details such as event type, user ID, timestamps, asset information, and audit status.

```json
[
  {
    "id": "62de6d714e29485a81824fe3",
    "eventType": "asset.create",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "assetId": "CA510292-E39E-4B28-AB6444CDD2B1C5C0",
    "assetType": "image",
    "assetName": "Product Insights",
    "assetAudit": "ACCEPTED",
    "fileName": "CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights"
  },
  {
    "id": "62de6d714e29485a81824fe4",
    "eventType": "asset.create",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "dateTime": "2021-11-15T10:08:18.752+00:00",
    "assetId": "C58ED8C6-6B09-4CD6-B71C32C6715834F1",
    "assetType": "image",
    "assetName": "Reporting Schedule Nov 2022",
    "assetAudit": "ACCEPTED",
    "fileName": "C58ED8C6-6B09-4CD6-B71C32C6715834F1___Reporting Schedule Nov 2022"
  }
]

```

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

### OpenAPI Example: Campaign Jobs

Source: https://api.bynder.com/reference/get_api-workflow-campaigns-id-jobs

This example demonstrates the structure of the JSON response when retrieving jobs for a specific campaign. It includes details on job stages, metadata, and timestamps.

```json
{
  "job_stages": [
    {
      "position": 1,
      "status": "Approved",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    {
      "position": 2,
      "status": "Active",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    {
      "position": 3,
      "status": "Idle",
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "dateModified": "2017-03-30T11:43:19+00:00",
  "presetID": null,
  "jobKey": "0000-0",
  "dateFinished": "2021-02-25T16:19:42+00:00",
  "jobFinishedHistory": [
    {
      "userId": "00000000-0000-0000-0000-000000000000",
      "date": "2021-02-24T16:23:48+00:00"
    },
    {
      "userId": "00000000-0000-0000-0000-000000000000",
      "date": "2021-02-25T16:19:42+00:00"
    }
  ],
  "jobMetaproperties": {
    "00000000-0000-0000-0000-000000000001": "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000002": "Country",
    "00000000-0000-0000-0000-000000000003": "City"
  },
  "createdByID": "00000000-0000-0000-0000-000000000000",
  "job_next_stage": {
    "position": 3,
    "status": "Idle",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "id": "00000000-0000-0000-0000-000000000000",
  "description": "",
  "accountableID": "00000000-0000-0000-0000-000000000000",
  "basedOnPreset": false,
  "dateCreated": "2017-03-30T11:42:30+00:00",
  "job_active_stage": {
    "position": 2,
    "status": "Active",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "deadline": null,
  "name": "Test API",
  "campaignID": "00000000-0000-0000-0000-000000000000",
  "job_previous_stage": {
    "position": 1,
    "status": "Approved",
    "id": "00000000-0000-0000-0000-000000000000"
  }
}
```

```json
{
  "job_stages": [
    {
      "position": 1,
      "status": "Approved",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    {
      "position": 2,
      "status": "Active",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    {
      "position": 3,
      "status": "Idle",
      "id": "00000000-0000-0000-0000-000000000000",
      "bookedMinutes": 5
    }
  ],
  "dateModified": "2017-03-30T11:43:19+00:00",
  "presetID": null,
  "jobKey": "0000-0",
  "dateFinished": null,
  "jobFinishedHistory": null,
  "jobMetaproperties": {
    "00000000-0000-0000-0000-000000000001": "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000002": "Country",
    "00000000-0000-0000-0000-000000000003": "City"
  },
  "createdByID": "00000000-0000-0000-0000-000000000000",
  "job_next_stage": {
    "position": 3,
    "status": "Idle",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "id": "00000000-0000-0000-0000-000000000000"
}
```

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

### Example Job Creation Response

Source: https://api.bynder.com/reference/post_api-workflow-jobs

This example shows the expected response when a new workflow job is successfully created. It includes the status and the unique ID of the created job.

```json
{
  "status": "Created",
  "job_id": "00000000-0000-0000-0000-000000000000"
}
```

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

### Example Asset Archive Response

Source: https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-archive

This JSON object represents an example response from the asset archive endpoint, detailing archived assets and their properties.

```json
[
  {
    "id": "62de6d714e29485a81824fe3",
    "eventType": "asset.archive",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "assetId": "CA510292-E39E-4B28-AB6444CDD2B1C5C0",
    "assetType": "image",
    "assetName": "Product Insights",
    "assetAudit": "ACCEPTED",
    "fileName": "CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights"
  },
  {
    "id": "62de6d714e29485a81824fe4",
    "eventType": "asset.archive",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "dateTime": "2021-11-15T10:08:18.752+00:00",
    "assetId": "C58ED8C6-6B09-4CD6-B71C32C6715834F1",
    "assetType": "image",
    "assetName": "Reporting Schedule Nov 2022",
    "assetAudit": "ACCEPTED",
    "fileName": "C58ED8C6-6B09-4CD6-B71C32C6715834F1___Reporting Schedule Nov 2022"
  }
]

```

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

### Retrieve Security Profiles Example

Source: https://api.bynder.com/reference/get_api-v4-profiles

This example shows the structure of a successful response when retrieving security profiles. It includes profile names, IDs, and the roles assigned to each profile.

```json
[
  {
    "name": "Admin",
    "id": "1",
    "roles": [
      "GROUPMANAGEMENT",
      "USERMANAGEMENT",
      "PERMISSIONMANAGEMENT"
    ]
  },
  {
    "name": "User",
    "id": "2",
    "roles": [
      "USERMANAGEMENT"
    ]
  }
]

```

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

### Client Credentials Grant Request Example

Source: https://api.bynder.com/reference/post_v6-authentication-oauth2-token-client-credentials

This example demonstrates the structure of a POST request to the token endpoint using the client credentials grant type. Ensure the correct URL and parameters are used.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "OAuth 2.0",
    "version": "1.0.0"
  },
  "tags": [
    {
      "name": "Token endpoint",
      "description": "Use the token endpoint to retrieve a access token which can be used to authorize API\nrequests. Depending on the type of grant, different fields are required which are\noutlined per request.\n\n_The token endpoint requires authorization either in the body or by\nsending the Authorization header._\n"
    }
  ],
  "paths": {
    "/v6/authentication/oauth2/token{client_credentials}": {
      "post": {
        "summary": "Using client credentials",
        "description": "Use the token endpoint to retrieve an access token which can be used to authorize API\nrequests. This endpoint supports the Authorization Code grant, the Refresh Token grant and the Client Credentials grant.\n",
        "tags": [
          "Token endpoint"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "client_id": {
                    "type": "string",
                    "description": "Application client ID.",
                    "example": "00000000-0000-0000-0000-000000000000"
                  },
                  "client_secret": {
                    "type": "string",
                    "description": "Application client secret.",
                    "example": "00000000-0000-0000-0000-000000000000"
                  },
                  "grant_type": {
                    "type": "string",
                    "description": "Identifies the grant type being used. For Authorization Code grant use **authorization_code**.",
                    "example": [
                      "authorization_code",
                      "refresh_token",
                      "client_credentials"
                    ]
                  },
                  "scope": {
                    "type": "string",
                    "description": "List of scopes to request to be granted to the access token. Can only be a subset of the scopes requested in the Authorize application request. When not passed, all the scopes will be requested.",
                    "example": "offline asset:read"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "refresh_token": {
                      "type": "string",
                      "example": "c12e...b5dc"
                    },
                    "token_type": {
                      "type": "string",
                      "example": "bearer"
                    },
                    "expires_in": {
                      "type": "integer",
                      "example": 3600
                    },
                    "access_token": {
                      "type": "string",
                      "example": "eyJh...NDcw"
                    },
                    "scope": {
                      "type": "string",
                      "example": "offline asset:read"
                    }
                  }
                },
                "examples": {
                  "example-1": {
                    "value": {
                      "token_type": "bearer",
                      "expires_in": 3600,
                      "access_token": "eyJh...NDcw",
                      "scope": "offline asset:read"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

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

### Invalid Token Response Example

Source: https://api.bynder.com/reference/get_api-v4-profiles-id

This example shows the response when an invalid or expired token is provided for authentication.

```text
Invalid or expired token.

```

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

### Example CSV Response

Source: https://api.bynder.com/reference/get_v7-analytics-api-v1-search-keyword-csv

This is an example of the CSV response format for search keyword events. It includes various metrics related to search queries.

```csv
id,eventType,userId,dateTime,keyword,totalResults,tagsResults,assetsResults,documentsResults,guidelinesResults,collectionsResults,metapropertiesResults,collectionAssetsResults,workflowCampaignsResults,brandstoreProductsResults
62de6d714e29485a81824fe3,search.keyword,"1A84D758-2B3A-141F-8F07D71AA1F223BD",1655823377864,"digital templates",27,0,24,0,0,3,0,0,0,0
62de6d714e29485a81824fe4,search.keyword,"1A84D758-2B3A-141F-8F07D71AA1F223BD",1655996103781,digital,56,0,48,0,0,8,0,0,0,0,0

```

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

### Example API Response for Assets

Source: https://api.bynder.com/reference/get_v7-analytics-api-v1-report-asset

This is an example response from the Get v7 Analytics API v1 Report Asset endpoint, showcasing the structure of returned asset data, including metadata and properties.

```json
[
  {
    "assetId": "3DF53D46-4E72-47A0-A42ECC22CDE211D5",
    "name": "Asset 1",
    "description": "Asset Description",
    "isArchived": false,
    "type": "image",
    "audit": "ACCEPTED",
    "copyright": "",
    "isLimited": false,
    "datePublished": "2016-12-29T10:39:52.000+00:00",
    "isRemoved": true,
    "dateRemoved": "2019-01-04T13:19:47.000+00:00",
    "idHash": "6bb400d042cfe865",
    "phash": "56033317620",
    "userCreated": "00000000-0000-0000-0000000000000000",
    "dateCreated": "2018-12-21T13:11:46.000+00:00",
    "userModified": "00000000-0000-0000-0000000000000000",
    "dateModified": "2019-01-04T13:19:47.000+00:00",
    "isWatermarked": false,
    "isPublic": false
  },
  {
    "assetId": "CD729A10-9101-47C7-9D14FA2E14CF28D9",
    "name": "Asset 2",
    "description": "Asset 2 description",
    "isArchived": false,
    "type": "image",
    "audit": "ACCEPTED",
    "copyright": "",
    "isLimited": false,
    "datePublished": "2019-03-31T23:55:21.000+00:00",
    "isRemoved": false,
    "idHash": "792e23855f02cdcb",
    "phash": "56033317620",
    "userCreated": "4BE80C1E-D8FF-4104-8CF774F06B1E60CE",
    "dateCreated": "2019-03-31T23:59:40.000+00:00",
    "userModified": "00000000-0000-0000-0000000000000000",
    "dateModified": "2020-12-04T21:18:27.000+00:00",
    "isWatermarked": false,
    "isPublic": false,
    "metaproperties": {
      "metaproperty_1": "option3",
      "metaproperty_2": "option2, option1",
      "metaproperty_3": ""
    }
  }
]

```

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

### Example Collection View Response

Source: https://api.bynder.com/reference/get_v7-analytics-api-v1-collection-views

This example demonstrates the structure of a successful response when retrieving collection view data. It includes details for multiple view events.

```json
[
  {
    "eventId": "ad3c8d01-4a2f-461c-b17d-2ecc51723028",
    "collectionId": "CA510292-E39E-4B28-AB6444CDD2B1C5C0",
    "eventType": "CollectionViewed",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "isOwner": false,
    "viewOrigin": "internal",
    "ipAddress": "192.158.1.38",
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36",
    "isBynderSupport": false
  },
  {
    "eventId": "ad3c8d01-4a2f-461c-b17d-2ecc51723028",
    "collectionId": "CA510292-E39E-4B28-AB6444CDD2B1C5C0",
    "eventType": "CollectionViewed",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "userId": "",
    "isOwner": false,
    "viewOrigin": "embed",
    "ipAddress": "192.158.1.38",
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36",
    "isBynderSupport": false
  }
]

```

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

### Retrieve Specific Security Profile Example

Source: https://api.bynder.com/reference/get_api-v4-profiles-id

This example demonstrates a successful response when retrieving a specific security profile. It includes the profile's name, ID, and associated roles.

```json
{
  "name": "Admin",
  "id": "1",
  "roles": [
    "GROUPMANAGEMENT",
    "USERMANAGEMENT",
    "PERMISSIONMANAGEMENT"
  ]
}

```

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

### Example Response: Grouped Dependencies

Source: https://api.bynder.com/reference/get_api-v4-metaproperties-id-options-optionid-dependencies-1

This example demonstrates a response when the `includeGroupedResults` query parameter is set to true. The dependencies are returned as a JSON object, with keys representing groups and values being arrays of dependency IDs.

```json
{
  "00000000-0000-0000-0000000000000000": [
    "00000000-0000-0000-0000000000000000",
    "00000000-0000-0000-0000000000000001",
    "00000000-0000-0000-0000000000000002"
  ],
  "ungrouped": [
    "00000000-0000-0000-0000000000000000"
  ]
}
```

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

### Example Workflow Job Object

Source: https://api.bynder.com/reference/get_api-workflow-jobs-id

This example shows the structure of a typical workflow job object returned by the API. It includes identifiers, dates, stage information, and metaproperties.

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Test API",
  "description": "",
  "deadline": null,
  "createdByID": "00000000-0000-0000-0000-000000000000",
  "accountableID": "00000000-0000-0000-0000-000000000000",
  "dateCreated": "2017-03-30T11:42:30+00:00",
  "dateModified": "2017-03-30T11:43:19+00:00",
  "basedOnPreset": false,
  "presetID": null,
  "campaignID": "00000000-0000-0000-0000-000000000000",
  "bookedMinutes": 10,
  "jobKey": "0000-0",
  "dateFinished": "2021-02-25T16:19:42+00:00",
  "jobFinishedHistory": [
    {
      "userId": "00000000-0000-0000-0000-000000000000",
      "date": "2021-02-24T16:23:48+00:00"
    },
    {
      "userId": "00000000-0000-0000-0000-000000000000",
      "date": "2021-02-25T16:19:42+00:00"
    }
  ],
  "job_stages": [
    {
      "position": 1,
      "status": "Approved",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    {
      "position": 2,
      "status": "Active",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    {
      "position": 3,
      "status": "Idle",
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "job_previous_stage": {
    "position": 1,
    "status": "Approved",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "job_active_stage": {
    "position": 2,
    "status": "Active",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "job_next_stage": {
    "position": 3,
    "status": "Idle",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "jobMetaproperties": {}
}
```

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

### Example Search Keyword Analytics Response

Source: https://api.bynder.com/reference/get_v7-analytics-api-v1-search-keyword

This example demonstrates the structure of a successful response when querying keyword search analytics. It includes details on total results, assets, and other breakdown categories for specific keywords.

```json
[
  {
    "id": "62de6d714e29485a81824fe3",
    "eventType": "search.keyword",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "keyword": "digital templates",
    "totalResults": 27,
    "tagsResults": 0,
    "assetsResults": 24,
    "documentsResults": 0,
    "guidelinesResults": 0,
    "collectionsResults": 3,
    "metapropertiesResults": 0,
    "collectionAssetsResults": 0,
    "workflowCampaignsResults": 0,
    "brandstoreProductsResults": 0
  },
  {
    "id": "62de6d714e29485a81824fe4",
    "eventType": "search.keyword",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "keyword": "assets",
    "totalResults": 56,
    "tagsResults": 0,
    "assetsResults": 48,
    "documentsResults": 0,
    "guidelinesResults": 0,
    "collectionsResults": 8,
    "metapropertiesResults": 0,
    "collectionAssetsResults": 0,
    "workflowCampaignsResults": 0,
    "brandstoreProductsResults": 0
  }
]

```

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

### OpenAPI Definition Example

Source: https://api.bynder.com/reference/post_api-v4-collections

This is a fragment of an OpenAPI definition file.

```yaml
}
      }
    }
  }
}
```

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

### Example CSV Response

Source: https://api.bynder.com/reference/get_v7-analytics-api-v1-historical-year-csv

This example shows the structure of the CSV data returned by the historical data endpoint. It includes event type, timestamp, user ID, and other relevant details.

```csv
asset.view,2023-03-25T07:26:09.739Z,1A84D758-2B3A-141F-8F07D71AA1F223BD,CA510292-E39E-4B28-AB6444CDD2B1C5C0,Product Insights,image,ACCEPTED,CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights,"","","","","","","",""
user.login,2023-03-22T12:26:23.862Z,1A84D758-2B3A-141F-8F07D71AA1F223BD,"","","","","","","","","","","","","",""
SearchExecuted,2023-02-23T11:03:30.971Z,1A84D758-2B3A-141F-8F07D71AA1F223BD,"","","","","","","","",[de],"","","",{168}

```

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

### Example CSV Response for Collection Views

Source: https://api.bynder.com/reference/get_v7-analytics-api-v1-collection-views-csv

This example demonstrates the structure of the CSV response when retrieving collection view events. It includes details such as event ID, collection ID, event type, timestamp, user ID, and more.

```csv
eventId,collectionId,eventType,dateTime,userId,isOwner,viewOrigin,ipAddress,userAgent,isBynderSupport
"ad3c8d01-4a2f-461c-b17d-2ecc51723028", "CA510292-E39E-4B28-AB6444CDD2B1C5C0", CollectionViewed, 2021-11-15T10:07:57.781+00:00, 1A84D758-2B3A-141F-8F07D71AA1F223BD, false, internal, 192.158.1.38, "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36", false
"ad3c8d01-4a2f-461c-b17d-2ecc51723028", "CA510292-E39E-4B28-AB6444CDD2B1C5C0", CollectionViewed, 2021-11-15T10:07:57.781+00:00,, false, embed, 192.158.1.38, "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36", false

```

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

### Get Media Endpoint Parameters

Source: https://api.bynder.com/reference/get_api-v4-media

This snippet details the query parameters available for the GET /api/v4/media endpoint.

```APIDOC
## GET /api/v4/media

### Description
Retrieves a list of media assets based on specified criteria.

### Method
GET

### Endpoint
/api/v4/media

### Parameters
#### Query Parameters
- **onlyPublic** (boolean) - Optional - Indicates whether or not the response should only contain assets marked as public.
- **keyword** (string) - Optional - Search on filenames, tags, extensions, collection names, guidelines, brandstore, campaigns in workflow, enriched PDFs, word documents.
- **dateCreated** (string, date-time) - Optional - Retrieve assets created after this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.
- **dateCreatedTo** (string, date-time) - Optional - Set a date range together with the "dateCreated" parameter. ISO8601 format yyyy-mm-ddThh:mm:ssZ.
- **dateCreatedOn** (string, date-time) - Optional - Retrieve assets created on this specific date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.
- **dateModified** (string, date-time) - Optional - Retrieve assets modified after this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.
- **dateModifiedTo** (string, date-time) - Optional - Set a date range together with the "dateModified" parameter. ISO8601 format yyyy-mm-ddThh:mm:ssZ.
- **dateModifiedOn** (string, date-time) - Optional - Retrieve assets modified on this specific date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.
- **orderBy** (string, enum) - Optional - Order of the returned list of assets. Possible values: "dateCreated asc", "dateModified asc", "datePublished asc", "name asc", "dateCreated desc", "dateModified desc", "datePublished desc", "name desc".
- **limit** (integer) - Optional - Maximum number of results. Defaults to 50. Maximum value is 1000.
- **page** (integer) - Optional - Offset page for results: return the N-th set of limit-results. Defaults to 1.
- **count** (boolean) - Optional - Indicating whether or not the response should include count results. Defaults to false.
- **total** (boolean) - Optional - Indicating whether or not the response should include the total count of results. Defaults to false.
- **includeMediaItems** (boolean) - Optional - Indicating whether or not the response should include all the different media items (derivatives) available for each asset. Defaults to false.
- **includeVersionNumber** (boolean) - Optional - Indicating whether or not the response should include the active version number. Defaults to false.
- **cursor** (string) - Optional - cursorMark returned in the X-Bynder-NextCursor response header which allows to return the next set of results.
```

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

### Get Report Asset

Source: https://api.bynder.com/reference/get_v7-analytics-api-v1-report-asset

Retrieves a list of assets with their associated details. This can be used to get an overview of assets or specific details for reporting purposes.

```APIDOC
## GET /v7/analytics/api/v1/report/asset

### Description
Retrieves a list of assets with their associated details.

### Method
GET

### Endpoint
/v7/analytics/api/v1/report/asset

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of assets to return.
- **offset** (integer) - Optional - The number of assets to skip before starting to collect the result set.
- **filter** (string) - Optional - Allows filtering assets based on various criteria. For example, `filter=name:Asset%201` or `filter=dateCreated:2018-12-21T13:11:46.000+00:00`.
- **sort** (string) - Optional - Allows sorting assets by specified fields. For example, `sort=name:asc` or `sort=dateCreated:desc`.

### Response
#### Success Response (200)
- **assetId** (string) - The unique identifier for the asset.
- **name** (string) - The name of the asset.
- **description** (string) - A description of the asset.
- **isArchived** (boolean) - Indicates if the asset is archived.
- **type** (string) - The type of the asset (e.g., 'image').
- **audit** (string) - The audit status of the asset (e.g., 'ACCEPTED').
- **copyright** (string) - Copyright information for the asset.
- **isLimited** (boolean) - Indicates if the asset has limited usage rights.
- **datePublished** (string) - The date the asset was published (ISO 8601 format).
- **isRemoved** (boolean) - Indicates if the asset has been removed.
- **dateRemoved** (string) - The date the asset was removed (ISO 8601 format).
- **idHash** (string) - A hash of the asset's ID.
- **phash** (string) - A perceptual hash of the asset.
- **userCreated** (string) - The ID of the user who created the asset.
- **dateCreated** (string) - The date the asset was created (ISO 8601 format).
- **userModified** (string) - The ID of the user who last modified the asset.
- **dateModified** (string) - The date the asset was last modified (ISO 8601 format).
- **isWatermarked** (boolean) - Indicates if the asset is watermarked.
- **isPublic** (boolean) - Indicates if the asset is publicly accessible.
- **metaproperties** (object) - An object containing metaproperties associated with the asset.

#### Response Example
```json
[
  {
    "assetId": "3DF53D46-4E72-47A0-A42ECC22CDE211D5",
    "name": "Asset 1",
    "description": "Asset Description",
    "isArchived": false,
    "type": "image",
    "audit": "ACCEPTED",
    "copyright": "",
    "isLimited": false,
    "datePublished": "2016-12-29T10:39:52.000+00:00",
    "isRemoved": true,
    "dateRemoved": "2019-01-04T13:19:47.000+00:00",
    "idHash": "6bb400d042cfe865",
    "phash": "56033317620",
    "userCreated": "00000000-0000-0000-0000000000000000",
    "dateCreated": "2018-12-21T13:11:46.000+00:00",
    "userModified": "00000000-0000-0000-0000000000000000",
    "dateModified": "2019-01-04T13:19:47.000+00:00",
    "isWatermarked": false,
    "isPublic": false
  },
  {
    "assetId": "CD729A10-9101-47C7-9D14FA2E14CF28D9",
    "name": "Asset 2",
    "description": "Asset 2 description",
    "isArchived": false,
    "type": "image",
    "audit": "ACCEPTED",
    "copyright": "",
    "isLimited": false,
    "datePublished": "2019-03-31T23:55:21.000+00:00",
    "isRemoved": false,
    "idHash": "792e23855f02cdcb",
    "phash": "56033317620",
    "userCreated": "4BE80C1E-D8FF-4104-8CF774F06B1E60CE",
    "dateCreated": "2019-03-31T23:59:40.000+00:00",
    "userModified": "00000000-0000-0000-0000000000000000",
    "dateModified": "2020-12-04T21:18:27.000+00:00",
    "isWatermarked": false,
    "isPublic": false,
    "metaproperties": {
      "metaproperty_1": "option3",
      "metaproperty_2": "option2, option1",
      "metaproperty_3": ""
    }
  }
]
```
```