Google Sheets

Looker Studio

` : `

Google Sheets

`; return `--- sidebarTitle: "Metrics & Dimensions" title: '${platform.title}' description: '${platform.description}' icon: '${platform.icon}' --- **Last updated:** ${currentDate}

${dimensionsCount} dimensions

${metricsCount} metrics

This reference covers all available dimensions and metrics for ${platform.name} data through Detrics. Use this guide to understand what data you can extract and how to structure your queries.

Supported destinations: ${destinationChips}

## Dimensions Dimensions are the attributes you can use to segment and group your ${platform.name} data. `; } // Function to escape HTML-like content in text function escapeHtml(text) { return text .replace(//g, ">") .replace(/"/g, """) .replace(/'/g, "'"); } // Function to generate table for a category function generateCategoryTable(fields) { if (!fields || fields.length === 0) return ""; let table = `| | | |--|--| `; fields.forEach((field) => { const displayName = escapeHtml(field.fieldDisplayName || field.fieldName); const tooltip = escapeHtml(field.tooltip || ""); const fieldName = field.fieldName; table += `|

${displayName}

| ${tooltip}

**Field Name:** \`${fieldName}\`
**Type:** dimension | `; }); return table + "\n"; } // Function to generate metrics table for a category function generateMetricsTable(fields) { if (!fields || fields.length === 0) return ""; let table = `| | | |--|--| `; fields.forEach((field) => { const displayName = escapeHtml(field.fieldDisplayName || field.fieldName); const tooltip = escapeHtml(field.tooltip || ""); const fieldName = field.fieldName; table += `|

${displayName}

| ${tooltip}

**Field Name:** \`${fieldName}\`
**Type:** metric | `; }); return table + "\n"; } // Function to group fields by category function groupByCategory(fields) { const grouped = {}; fields.forEach((field) => { const category = field.category || "Other"; if (!grouped[category]) { grouped[category] = []; } grouped[category].push(field); }); return grouped; } // Function to generate complete MDX content function generateMDXContent(platformKey, data) { const platform = platforms[platformKey]; if (!platform) return ""; // Get the main data key (varies by platform) const dataKey = Object.keys(data)[0]; const platformData = data[dataKey]; if (!platformData) return generateMDXHeader(platform, 0, 0); // Count dimensions and metrics const dimensionsCount = platformData.dimensions ? platformData.dimensions.length : 0; const metricsCount = platformData.metrics ? platformData.metrics.length : 0; let content = generateMDXHeader(platform, dimensionsCount, metricsCount); // Generate dimensions if (platformData.dimensions && platformData.dimensions.length > 0) { const dimensionsByCategory = groupByCategory(platformData.dimensions); Object.keys(dimensionsByCategory).forEach((category) => { content += `### ${category}\n\n`; content += generateCategoryTable(dimensionsByCategory[category]); }); } // Generate metrics if (platformData.metrics && platformData.metrics.length > 0) { content += `## Metrics Metrics are the numerical values you can measure and analyze from your ${platform.name} campaigns. `; const metricsByCategory = groupByCategory(platformData.metrics); Object.keys(metricsByCategory).forEach((category) => { content += `### ${category}\n\n`; content += generateMetricsTable(metricsByCategory[category]); }); } return content; } // Main function to process all platforms function generateAllMetrics() { const inputDir = "./claude-input/json/available-fields"; Object.keys(platforms).forEach((platformKey) => { const inputFile = path.join(inputDir, `${platformKey}.json`); const platform = platforms[platformKey]; // Check if input file exists if (!fs.existsSync(inputFile)) { console.log(`⚠️ Input file not found: ${inputFile}`); return; } try { // Read and parse JSON const jsonData = JSON.parse(fs.readFileSync(inputFile, "utf8")); // Generate MDX content const mdxContent = generateMDXContent(platformKey, jsonData); // Ensure output directory exists const outputDir = path.dirname(platform.outputPath); if (!fs.existsSync(outputDir)) { fs.mkdirSync(outputDir, { recursive: true }); } // Write MDX file fs.writeFileSync(platform.outputPath, mdxContent); console.log(`✅ Generated: ${platform.outputPath}`); } catch (error) { console.error(`❌ Error processing ${platformKey}:`, error.message); } }); } // Run the script if (require.main === module) { console.log("🚀 Generating metrics documentation...\n"); generateAllMetrics(); console.log("\n✨ Done!"); } module.exports = { generateAllMetrics, generateMDXContent };

Quickstart

How-To Guides

Concepts

Reference