| Time | Status | User Agent |  |
| :-- | :-- | :-- | :-- |
| Make a request to see history. |

#### URL Expired

The URL for this request expired after 30 days.

### name_patterns

- array of strings

Optional stable selectors that match logical tables by name.

Defaults to `[%]` when omitted.

### name_patterns

- ADD string

### page

- integer

≥ 1

Defaults to 1

1-based page number for pagination.

### per_page

- integer

≥ 1

Number of logical tables to return per page.

### api-version

- integer

required

Target API version

# `200      Success`

- object

### data_sources

- array of objects

required

#### data_sources*

- object

### name_patterns

- array of strings

required

Stable selector to send back to `/reporting/data.name_patterns`.

### logical_table_name

- string

Human-readable name of the logical table. Returned for display purposes.

### column_names

- array of strings

required

Exact column labels clients may request in `/reporting/data.columns`.

### filters

- array of objects

required

Query-string filter metadata for `/reporting/data.filters`.

#### filters*

- object

### name

- string

required

Exact column label clients may send in `/reporting/data.filters[*].column_name`.

### operators

- array of strings

required

Operators supported by `/reporting/data.filters` for this column.

The query-string filter path is currently equality-only.

`EQ`

### data_type

- string

Reporting data type when available.

### allowed_values

- array

Enumerated values when the column metadata exposes them.

allowed_values

- string
      - number
      - integer
      - boolean

### runtime_filters

- array of objects

required

Column-level runtime filter metadata for `/reporting/data.runtime_filters`.

#### runtime_filters*

- object

### name

- string

required

Exact column label clients may send in `/reporting/data.runtime_filters[*].column_name`.

### operators

- array of strings

required

Operators supported by `/reporting/data.runtime_filters` for this column.

Date and datetime columns expose range operators such as `BW` and `BW_INC`.

`EQ``BW``BW_INC``GT``GTE``LT``LTE`

### data_type

- string

Reporting data type when available.

### allowed_values

- array

Enumerated values when the column metadata exposes them.

allowed_values

- string
      - number
      - integer
      - boolean

### runtime_parameters

- array of objects

required

Parameter metadata for `/reporting/data.runtime_param_override`.

#### runtime_parameters*

- object

### name

- string

required

Exact parameter name clients may send in `/reporting/data.runtime_param_override[*].name`.

### operators

- array of strings

required

`EQ`

### data_type

- string

Reporting data type when available.

### default_value

- string

Default value when the parameter metadata exposes one.

### allowed_values

- array

Enumerated values when the parameter metadata exposes them.

allowed_values

- string
      - number
      - integer
      - boolean

# `400      Bad Request`

# `401      Unauthorized`

# `403      Forbidden`

# `406      Not Acceptable`

# `422      Unprocessable Content`

Updated3 months ago

* * *

ShellNodeRubyPHPPython

Bearer

Base URL

https://api.dealerware.com/reporting/metadata

```
    xxxxxxxxxx
    curl --request POST \
         --url https://api.dealerware.com/reporting/metadata \
         --header 'accept: application/json' \
         --header 'content-type: application/json' \
         --data '{"page":1}'
    ```

```
    xxxxxxxxxx
    ```

{
      "data_sources": [
        {
          "name_patterns": [
            "Contracts"
          ],
          "logical_table_name": "Contracts",
          "column_names": [
            "DBA Name",
            "Dealer Code",
            "Region",
            "Contract Duration",
            "Contract Status"
          ],
          "filters": [
            {
              "name": "DBA Name",
              "operators": [
                "EQ"
              ],
              "data_type": "VARCHAR",
              "allowed_values": [
                "Dealer One",
                "Dealer Two"
              ]
            },
            {
              "name": "Dealer Code",
              "operators": [
                "EQ"
              ],
              "data_type": "VARCHAR"
            },
            {
              "name": "Region",
              "operators": [
                "EQ"
              ],
              "data_type": "VARCHAR"
            },
            {
              "name": "Contract Status",
              "operators": [
                "EQ"
              ],
              "data_type": "VARCHAR"
            }
          ],
          "runtime_filters": [
            {
              "name": "Actual Dropoff At",
              "operators": [
                "EQ",
                "BW",
                "BW_INC",
                "GT",
                "GTE",
                "LT",
                "LTE"
              ],
              "data_type": "DATE_TIME"
            }
          ],
          "runtime_parameters": [
            {
              "name": "oem",
              "operators": [
                "EQ"
              ],
              "data_type": "CHAR",
              "default_value": "Acura",
              "allowed_values": [
                "Acura",
                "Audi",
                "BMW"
              ]
            }
          ]
        }
      ]
    }

Updated3 months ago

* * *

Did this page help you?

Yes

No