Odyssey Stats: Add API support for Location stats (#40852)

* Add API support for Location views stats

* changelog

projects/packages/stats-admin/changelog/add-odyssey-stats-location-views-api

@@ -0,0 +1,4 @@
+Significance: minor
+Type: added
+
+Stats: added API support for location stats

projects/packages/stats-admin/src/class-rest-controller.php

@@ -425,6 +425,17 @@ public function register_rest_routes() {
 				'permission_callback' => array( $this, 'can_user_view_general_stats_callback' ),
 			)
 		);
+
+		// Get Location stats.
+		register_rest_route(
+			static::$namespace,
+			sprintf( '/sites/%d/stats/location-views/(?P<geo_mode>country|region|city)', Jetpack_Options::get_option( 'id' ) ),
+			array(
+				'methods'             => WP_REST_Server::READABLE,
+				'callback'            => array( $this, 'get_location_stats' ),
+				'permission_callback' => array( $this, 'can_user_view_general_stats_callback' ),
+			)
+		);
 	}
 
 	/**
@@ -974,6 +985,20 @@ public function get_devices_stats_time_series( $req ) {
 		);
 	}
 
+	/**
+	 * Get Location stats.
+	 *
+	 * @param WP_REST_Request $req The request object.
+	 * @return array
+	 */
+	public function get_location_stats( $req ) {
+		$params   = $req->get_params();
+		$geo_mode = $params['geo_mode'];
+		unset( $params['geo_mode'] );
+
+		return $this->wpcom_stats->get_views_by_location( $geo_mode, $params );
+	}
+
 	/**
 	 * Dismiss or delay stats notices.
 	 *

projects/packages/stats/changelog/add-odyssey-stats-location-views-api

@@ -0,0 +1,4 @@
+Significance: minor
+Type: added
+
+Stats: added API support for location stats

projects/packages/stats/src/class-wpcom-stats.php

@@ -232,6 +232,19 @@ public function get_views_by_country( $args = array() ) {
 		return $this->fetch_stats( $args );
 	}
 
+	/**
+	 * Get site's views by location.
+	 *
+	 * @param string $geo_mode The type of location to fetch views for (country, region, city).
+	 * @param array  $args     Optional query parameters.
+	 * @return array|WP_Error
+	 */
+	public function get_views_by_location( $geo_mode, $args = array() ) {
+		$this->resource = sprintf( 'location-views/%s', $geo_mode );
+
+		return $this->fetch_stats( $args );
+	}
+
 	/**
 	 * Get site's followers.
 	 *