Getting Your Clash Sets in External Applications

Overview

The ClashWise Developer API allows you to securely export your clash data for use in third-party reporting tools like PowerBI, Excel, Tableau, or custom internal dashboards. The API is read-only and is available on Clash Management plans (Pro and Business), including the free trial.

Authentication

The API uses Basic Authentication. You must generate an API key pair (Client ID and Client Secret) from your Profile to authenticate.

Generating API keys

1. Sign in to the ClashWise web app at https://clashwise.ai.
2. Open the navigation drawer and select Profile.
3. Scroll to the API ACCESS card.
4. Select Generate New API Key and name the key.
5. Important: copy the Client Secret from the API Key Details dialog immediately — it is only shown once.

For key limits, revocation, and security guidance, see the Managing API Keys article in this section.

Using the credentials

You can authenticate in two ways:

1. Basic Authentication (recommended)

Combine your Client ID and Client Secret into a base64-encoded string: Base64(ClientId:ClientSecret).

Header:

Authorization: Basic <Base64String>

Most tools like Postman or PowerBI handle the encoding for you when you select "Basic Auth" and enter your Client ID as the username and Client Secret as the password.

2. Custom headers (alternative)

You can also pass credentials via custom headers:

x-client-id: <Your-Client-ID>
x-client-secret: <Your-Client-Secret>

---

Endpoints

1. Export Clash Data

Retrieves a paginated list of clashes based on your filters.

Method: GET URL: https://api.clashwise.ai/export/clash-data

Parameter	Type	Required	Description	Default
page	Integer	No	The page number to retrieve (1-based).	1
pageSize	Integer	No	The number of items per page (Max 500).	50
clashSetId	String	No	Filter clashes by a specific Clash Set ID.	All Sets
status	String	No	Filter clashes by status (e.g., New, Active, Resolved, Approved).	All Statuses
priority	String	No	Filter clashes by priority (e.g., Critical, High, Moderate, Low).	All Priorities
isAnalyzed	Boolean	No	Filter by analysis status (true or false).	Both
recommendedPriorityId	String	No	Filter by the ID of the recommended priority.	All
recommendedStatusId	String	No	Filter by the ID of the recommended status.	All
recommendedContactId	String	No	Filter by the ID of the recommended contact.	All
modifiedById	String	No	Filter items modified by a specific user ID.	All Users
modifiedSince	DateTime	No	Filter items modified since a specific date (ISO 8601).	All Time

Response format (JSON)

{
  "data": [
    {
      "id": "guid-string",
      "clashTitle": "Cable Tray vs Beam",
      "status": "Active",
      "priority": "High",
      "clashTest": "Electrical vs Structural",
      "dateFound": "2023-10-27T10:00:00Z",
      "clashDescription": "Hard clash between tray and steel.",
      "clashSetId": "set-guid-string",
      "clashSetName": "Federated Model Week 42",
      "isAnalyzed": true,
      "recommendedPriorityId": "priority-struct-guid",
      "recommendedStatusId": "status-active-guid",
      "recommendedContactId": "contact-john-doe-guid",
      "userModified": false
    }
  ],
  "page": 1,
  "pageSize": 50,
  "totalCount": 0,
  "hasMore": true,
  "nextPageLink": "https://api.clashwise.ai/export/clash-data?page=2&pageSize=50"
}

Paging through large sets

Use hasMore and nextPageLink to walk through all pages: keep requesting nextPageLink until hasMore is false.

Tip: the recommendedPriorityId, recommendedStatusId, and recommendedContactId fields hold the identifiers of the AI-recommended values from your clash matrix. Use the contacts endpoint (see Getting Available Contacts) to translate contact IDs into names for reporting.

---

Integration guides

PowerBI integration

1. Open PowerBI Desktop.
2. Select Get Data > Web.
3. Enter the API URL: https://api.clashwise.ai/export/clash-data.
4. In the access dialog, select Basic.
5. Username: enter your Client ID.
6. Password: enter your Client Secret.
7. Click Connect.
8. PowerBI will retrieve the JSON data. You can then expand the data list to visualize your clashes.

Excel integration

1. Go to the Data tab > From Web.
2. Enter the API URL.
3. Select Basic authentication.
4. Enter your credentials (Client ID / Secret).
5. Use Power Query to transform the JSON response into a table.

---

Security best practices

• Keep your Client Secret private. Never share it or commit it to version control.
• If you suspect a key has been compromised, revoke it immediately from your Profile's API ACCESS card and generate a new one.
• Use HTTPS for all requests to ensure credentials are encrypted in transit.

Related topics

• Managing API Keys
• Getting Available Contacts