Vocabulary and parameters

The fixed metric ids, the metric families, the grains, and every accepted parameter. Costs no query.

curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/correlation/options" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://mythic-analytics.gulp.workers.dev/client/v1/correlation/options"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

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

const response = await fetch("https://mythic-analytics.gulp.workers.dev/client/v1/correlation/options", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://mythic-analytics.gulp.workers.dev/client/v1/correlation/options", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://mythic-analytics.gulp.workers.dev/client/v1/correlation/options')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

{
  "success": true,
  "grains": [
    "day",
    "week",
    "month"
  ],
  "fixed_metrics": [
    {
      "id": "spend",
      "label": "Ad spend (Meta)",
      "unit": "count",
      "source": "events",
      "available": true,
      "occurrences": 42
    }
  ],
  "metric_families": [
    {}
  ],
  "params": {}
}

GET

/client/v1/correlation/options

GET

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

Bearer Tokenstring

Required

Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need correlation:read. See Using an mcp_ key over HTTP.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need correlation:read. See Using an mcp_ key over HTTP.

Responses

successboolean

grainsstring[]

fixed_metricsarray

metric_familiesobject[]

paramsobject

Was this page helpful?