mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "anchors": [
    {
      "icon": "circle-info",
      "iconType": "sharp-solid",
      "name": "Help Center",
      "url": "https://dub.co/help"
    },
    {
      "icon": "github",
      "name": "GitHub",
      "url": "https://github.com/dubinc/dub"
    }
  ],
  "api": { "maintainOrder": true },
  "backgroundImage": "/images/background.png",
  "colors": {
    "anchors": { "from": "#FF7F57", "to": "#9563FF" },
    "background": { "dark": "#090014" },
    "dark": "#0D001D",
    "light": "#AE87FF",
    "primary": "#9563FF"
  },
  "favicon": "/logos/favicon.png",
  "feedback": { "thumbsRating": true, "suggestEdit": true },
  "footerSocials": {
    "github": "https://github.com/dubinc/dub",
    "linkedin": "https://www.linkedin.com/company/dubinc",
    "twitter": "https://twitter.com/dubdotco",
    "website": "https://dub.co"
  },
  "logo": {
    "dark": "/logos/wordmark-dark.svg",
    "href": "https://dub.co",
    "light": "/logos/wordmark.svg"
  },
  "name": "Dub.co Docs",
  "navigation": [
    { "group": "Getting Started", "pages": ["introduction", "data-model"] },
    {
      "group": "Quickstart",
      "pages": [
        {
          "group": "Typescript",
          "icon": "js",
          "pages": [
            "quickstart/typescript",
            "quickstart/nextjs",
            "quickstart/remix",
            "quickstart/nuxt",
            "quickstart/express"
          ]
        },
        { "group": "Go", "icon": "golang", "pages": ["quickstart/go"] },
        {
          "group": "Python",
          "icon": "python",
          "pages": [
            "quickstart/python",
            "quickstart/flask",
            "quickstart/django"
          ]
        },
        {
          "group": "Ruby",
          "icon": "gem",
          "pages": ["quickstart/ruby", "quickstart/rails", "quickstart/sinatra"]
        }
      ]
    },
    { "group": "Resources", "pages": ["integrations", "examples"] },
    { "group": "Open source", "pages": ["local-development", "self-hosting"] },
    {
      "group": "API Reference",
      "pages": [
        "api-reference/introduction",
        "api-reference/tokens",
        "api-reference/rate-limits",
        "api-reference/errors"
      ]
    },
    {
      "group": "Links",
      "pages": [
        "api-reference/endpoint/create-a-new-link",
        "api-reference/endpoint/retrieve-a-link",
        "api-reference/endpoint/update-a-link",
        "api-reference/endpoint/upsert-a-link",
        "api-reference/endpoint/delete-a-link",
        "api-reference/endpoint/retrieve-a-list-of-links",
        "api-reference/endpoint/retrieve-number-of-links",
        "api-reference/endpoint/bulk-create-links",
        "api-reference/endpoint/bulk-update-links"
      ]
    },
    {
      "group": "Analytics",
      "pages": ["api-reference/endpoint/retrieve-analytics"]
    },
    {
      "group": "QR Codes",
      "pages": ["api-reference/endpoint/retrieve-a-qr-code"]
    },
    {
      "group": "Workspaces",
      "pages": [
        "api-reference/endpoint/retrieve-a-workspace",
        "api-reference/endpoint/update-a-workspace"
      ]
    },
    {
      "group": "Domains",
      "pages": [
        "api-reference/endpoint/create-a-domain",
        "api-reference/endpoint/update-a-domain",
        "api-reference/endpoint/delete-a-domain",
        "api-reference/endpoint/retrieve-a-list-of-domains"
      ]
    },
    {
      "group": "Tags",
      "pages": [
        "api-reference/endpoint/create-a-new-tag",
        "api-reference/endpoint/retrieve-a-list-of-tags",
        "api-reference/endpoint/update-a-tag"
      ]
    },
    {
      "group": "Metatags",
      "pages": ["api-reference/endpoint/retrieve-metatags"]
    },
    {
      "group": "Conversions [BETA]",
      "pages": [
        "api-reference/endpoint/track-lead",
        "api-reference/endpoint/track-sale",
        "api-reference/endpoint/track-customer"
      ]
    },
    { "group": "SDKs", "pages": ["sdks/overview", "sdks/js-client/overview"] },
    {
      "group": "TypeScript",
      "pages": [
        "sdks/typescript/overview",
        {
          "group": "Links",
          "icon": "link",
          "pages": [
            "sdks/typescript/links/create",
            "sdks/typescript/links/get",
            "sdks/typescript/links/update",
            "sdks/typescript/links/upsert",
            "sdks/typescript/links/delete",
            "sdks/typescript/links/list",
            "sdks/typescript/links/count",
            "sdks/typescript/links/create-many"
          ]
        },
        {
          "group": "Analytics",
          "icon": "chart-line",
          "pages": ["sdks/typescript/analytics/retrieve"]
        },
        {
          "group": "Workspaces",
          "icon": "folder",
          "pages": [
            "sdks/typescript/workspaces/get",
            "sdks/typescript/workspaces/update"
          ]
        },
        {
          "group": "Domains",
          "icon": "globe",
          "pages": [
            "sdks/typescript/domains/create",
            "sdks/typescript/domains/update",
            "sdks/typescript/domains/delete",
            "sdks/typescript/domains/list"
          ]
        },
        {
          "group": "Tags",
          "icon": "tag",
          "pages": [
            "sdks/typescript/tags/create",
            "sdks/typescript/tags/list",
            "sdks/typescript/tags/update"
          ]
        },
        {
          "group": "Metatags",
          "icon": "image",
          "pages": ["sdks/typescript/metatags/get"]
        }
      ]
    }
  ],
  "openapi": "/openapi-with-code-samples.yaml",
  "redirects": [
    { "destination": "/sdks/overview", "source": "/sdks" },
    { "destination": "/integrations", "source": "/integrations/:path*" },
    { "destination": "/self-hosting", "source": "/self-hosting/guide" },
    {
      "destination": "/api-reference/endpoint/retrieve-a-workspace",
      "source": "/api-reference/endpoint/retrieve-a-project"
    },
    {
      "destination": "/api-reference/endpoint/retrieve-a-list-of-workspaces",
      "source": "/api-reference/endpoint/retrieve-a-list-of-projects"
    },
    {
      "destination": "/api-reference/endpoint/update-a-link",
      "source": "/api-reference/endpoint/edit-a-link"
    },
    {
      "destination": "/api-reference/endpoint/update-a-domain",
      "source": "/api-reference/endpoint/edit-a-domain"
    },
    {
      "destination": "/api-reference/endpoint/retrieve-browsers-by-clicks",
      "source": "/api-reference/endpoint/retrieve-browser"
    },
    {
      "destination": "/api-reference/endpoint/retrieve-cities-by-clicks",
      "source": "/api-reference/endpoint/retrieve-city"
    },
    {
      "destination": "/api-reference/endpoint/retrieve-clicks-count",
      "source": "/api-reference/endpoint/retrieve-clicks"
    },
    {
      "destination": "/api-reference/endpoint/retrieve-countries-by-clicks",
      "source": "/api-reference/endpoint/retrieve-country"
    },
    {
      "destination": "/api-reference/endpoint/retrieve-devices-by-clicks",
      "source": "/api-reference/endpoint/retrieve-device"
    },
    {
      "destination": "/api-reference/endpoint/retrieve-os-by-clicks",
      "source": "/api-reference/endpoint/retrieve-os"
    },
    {
      "destination": "/api-reference/endpoint/retrieve-referers-by-clicks",
      "source": "/api-reference/endpoint/retrieve-referer"
    },
    {
      "destination": "/api-reference/endpoint/retrieve-timeseries-clicks",
      "source": "/api-reference/endpoint/retrieve-timeseries"
    },
    {
      "destination": "/api-reference/endpoint/retrieve-top-links-by-clicks",
      "source": "/api-reference/endpoint/retrieve-top-links"
    },
    {
      "destination": "/api-reference/endpoint/retrieve-top-urls-by-clicks",
      "source": "/api-reference/endpoint/retrieve-top-urls"
    },
    {
      "destination": "/sdks/typescript/analytics/clicks/count",
      "source": "/sdks/typescript/analytics/clicks"
    },
    {
      "destination": "/sdks/typescript/analytics/clicks/timeseries",
      "source": "/sdks/typescript/analytics/timeseries"
    },
    {
      "destination": "/sdks/typescript/analytics/clicks/browsers",
      "source": "/sdks/typescript/analytics/browsers"
    },
    {
      "destination": "/sdks/typescript/analytics/clicks/cities",
      "source": "/sdks/typescript/analytics/cities"
    },
    {
      "destination": "/sdks/typescript/analytics/clicks/countries",
      "source": "/sdks/typescript/analytics/countries"
    },
    {
      "destination": "/sdks/typescript/analytics/clicks/devices",
      "source": "/sdks/typescript/analytics/devices"
    },
    {
      "destination": "/sdks/typescript/analytics/clicks/os",
      "source": "/sdks/typescript/analytics/os"
    },
    {
      "destination": "/sdks/typescript/analytics/clicks/referers",
      "source": "/sdks/typescript/analytics/referers"
    },
    {
      "destination": "/sdks/typescript/analytics/clicks/top-links",
      "source": "/sdks/typescript/analytics/top-links"
    },
    {
      "destination": "/sdks/typescript/analytics/clicks/top-urls",
      "source": "/sdks/typescript/analytics/top-urls"
    },
    { "destination": "/quickstart/typescript", "source": "/quickstart/nodejs" },
    {
      "destination": "/sdks/typescript/domains/create",
      "source": "/sdks/typescript/domains/add"
    },
    {
      "destination": "/api-reference/endpoint/create-a-domain",
      "source": "/api-reference/endpoint/add-a-domain"
    }
  ],
  "tabs": [
    { "name": "API Reference", "url": "api-reference" },
    { "name": "SDKs", "url": "sdks" }
  ],
  "topbarCtaButton": { "name": "Dashboard", "url": "https://app.dub.co" },
  "topbarLinks": [{ "name": "Support", "url": "mailto:support@dub.co" }]
}