Skip to content

Latest commit

 

History

History
149 lines (96 loc) · 5.27 KB

DimensionsApi.md

File metadata and controls

149 lines (96 loc) · 5.27 KB
Raw

\DimensionsApi

All URIs are relative to https://api.mux.com

Method HTTP request Description
ListDimensionValues Get /data/v1/dimensions/{DIMENSION_ID} Lists the values for a specific dimension
ListDimensions Get /data/v1/dimensions List Dimensions

ListDimensionValues

ListDimensionValuesResponse ListDimensionValues(ctx, dIMENSIONID).Limit(limit).Page(page).Filters(filters).Timeframe(timeframe).Execute()

Lists the values for a specific dimension

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    dIMENSIONID := "abcd1234" // string | ID of the Dimension
    limit := int32(56) // int32 | Number of items to include in the response (optional) (default to 25)
    page := int32(56) // int32 | Offset by this many pages, of the size of `limit` (optional) (default to 1)
    filters := []string{"Inner_example"} // []string | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.  (optional)
    timeframe := []string{"Inner_example"} // []string | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...   * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600   * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.DimensionsApi.ListDimensionValues(context.Background(), dIMENSIONID).Limit(limit).Page(page).Filters(filters).Timeframe(timeframe).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DimensionsApi.ListDimensionValues``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListDimensionValues`: ListDimensionValuesResponse
    fmt.Fprintf(os.Stdout, "Response from `DimensionsApi.ListDimensionValues`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dIMENSIONID string ID of the Dimension

Other Parameters

Other parameters are passed through a pointer to a apiListDimensionValuesRequest struct via the builder pattern

Name Type Description Notes

limit | int32 | Number of items to include in the response | [default to 25] page | int32 | Offset by this many pages, of the size of `limit` | [default to 1] filters | []string | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. | timeframe | []string | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days. |

Return type

ListDimensionValuesResponse

Authorization

accessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListDimensions

ListDimensionsResponse ListDimensions(ctx).Execute()

List Dimensions

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.DimensionsApi.ListDimensions(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DimensionsApi.ListDimensions``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListDimensions`: ListDimensionsResponse
    fmt.Fprintf(os.Stdout, "Response from `DimensionsApi.ListDimensions`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiListDimensionsRequest struct via the builder pattern

Return type

ListDimensionsResponse

Authorization

accessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]