## Documentation Index

Fetch the complete documentation index at: [/llms.txt](https://developer.mindbridge.ai/llms.txt)

Use this file to discover all available pages before exploring further.

GET

/v1

analysis-types

{analysisTypeId}

# Read Analysis Type

## cURL

```bash
curl --request GET \
  --url https://{tenant}.mindbridge.ai/api/v1/analysis-types/{analysisTypeId} \
  --header 'Authorization: Bearer <token>'
```

## Python

```python
import requests

url = "https://{tenant}.mindbridge.ai/api/v1/analysis-types/{analysisTypeId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## JavaScript

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenant}.mindbridge.ai/api/v1/analysis-types/{analysisTypeId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

## PHP

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.mindbridge.ai/api/v1/analysis-types/{analysisTypeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>
```

## Go

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

url := "https://{tenant}.mindbridge.ai/api/v1/analysis-types/{analysisTypeId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}
```

## Unirest (Java)

```java
HttpResponse<String> response = Unirest.get("https://{tenant}.mindbridge.ai/api/v1/analysis-types/{analysisTypeId}")
  .header("Authorization", "Bearer <token>")
  .asString();
```

## Ruby

```ruby
require 'uri'
require 'net/http'

url = URI("https://{tenant}.mindbridge.ai/api/v1/analysis-types/{analysisTypeId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

## Response

200

```json
{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "name": "<string>",
  "interimName": "<string>",
  "description": "<string>",
  "accountMappingRequired": true,
  "fundSupported": true,
  "interimSupported": true,
  "periodicSupported": true,
  "archived": true,
  "maxPeriod": 123,
  "sourceConfigurations": [
    {
      "sourceTypeId": "<string>",
      "required": true,
      "postAnalysis": true,
      "interimOnly": true,
      "disableForInterim": true,
      "allowMultiple": true,
      "allowMultipleForPeriodic": true,
      "alternativeRequiredSourceTypes": [
        "<string>"
      ],
      "tracksAdditionalDataEntries": true
    }
  ]
}
```

### Authorizations

**Authorization**

- Type: string
- Location: header
- Required: Yes
- Description: Bearer authentication header of the form `Bearer <token>`, where `<token>` is your auth token.

### Path Parameters

**analysisTypeId**
- Type: string
- Required: Yes

### Response

200 - application/json

#### Attributes
- **id**: string - The unique object identifier.
- **version**: integer - Data integrity version to ensure data consistency.
- **creationDate**: string - The date that the object was originally created.
- **lastModifiedDate**: string - The date that the object was last updated or modified.
- **createdUserInfo**: object - Details about the user who created the object.
- **lastModifiedUserInfo**: object - Details about the user who last modified or updated the object.
- **name**: string - The name of the analysis type.
- **interimName**: string - The name of the analysis type when the analysis uses an interim time frame.
- **description**: string - The description of the analysis type.
- **accountMappingRequired**: boolean - Indicates whether or not account mapping must be performed.
- **fundSupported**: boolean - Indicates whether or not the analysis supports restricted and unrestricted funds.
- **interimSupported**: boolean - Indicates whether or not the analysis supports the interim time frame.
- **periodicSupported**: boolean - Indicates whether or not the analysis supports the periodic time frame.
- **archived**: boolean - Indicates whether or not the analysis type has been archived.
- **maxPeriod**: integer - A configuration value for the max analysis period.
- **sourceConfigurations**: array - A list of analysis source configurations that can be imported into the analysis, as determined by the analysis type.