Wikimedia Foundation Culture and Heritage team/Commons Impact Metrics Requests
This page describes the process for adding a request to the Commons Impact Metrics dataset and having your content partnership category tracked. This process considers Pageviews as the base metric for the dataset.
In order to have the category added to the dataset, check the following steps:
Step by step of adding categories
[edit]1. Create a Wikimedia Commons category to keep track of your cultural heritage (GLAM) initiative
- We recommend the category to be as general as possible within your entity or initiative, in other words, "an umbrella category", that includes all important subcategories you want to keep track of:
- A Commons mass contributor actor/entity. For instance, the category of a specific museum, library, individual mass contributor, etc. (“Media_contributed_by_someone” or “National_Museum_of_someplace”).
- An event or a project aimed at generating Commons mass contribution. For instance, a campaign or an edit-a-thon organized to generate mass contribution. (“Wiki Loves Something”, “Images_uploaded_as_part_of_some_collaboration”).
- N.B.: That will only report on sub-categories that are at a maximum distance of 7 steps from the allow-listed primary category.
- Check the process for creating a Wikimedia Commons category or subcategory using this link.
- Some examples of categories for GLAM-Wiki initiatives:
2. Upload files to the category or add/move them to the category you want to keep track of
- You can also upload or move the files to a subcategory of the primary category.
3. Check if the category is not yet part of the current Commons Impact Metrics allow-list on GitLab
4. Open a request for your category to be tracked by the Commons Impact Metrics API
- The request is accomplished by this pre-filled form on Phabricator.
- How to fill out the form:
- Title: Request for CATEGORY NAME (Remove 'CATEGORY NAME' and add the name of the category)
- Description:
- Category name: Category_name_here (Remove 'Category_name_here' and add the name of the category)
- Copy the category name from the URL; after “Category:” until the end of the URL. Example: Images_from_Memòria_Digital_de_Catalunya. Note the underscores instead of spaces.
- Task: Add new category, Remove category, Rename category (Choose between the three options; you can also request more than one category at a time)
- Additional information or request: (optional) (Fill in this field with the change you will need to make if you want to rename or remove a category, e.g. remove category A and replace it with category B; or edit the name of category C and apply category D)
- Initiative name or URL: (optional) (Add the name and/or link to the page of your project or initiative for additional context)
- Category name: Category_name_here (Remove 'Category_name_here' and add the name of the category)
- Subscribers: FRomeo_WMF (Add more users if necessary)
- Assigned: GFontenelle_WMF (Please don't change this)
- Projects: Commons-Impact-Metrics-Requests (Please don't change this)
- The request will be added to the Commons Impact Metrics requests workboard maintained by the Culture and Heritage team.
- N.B.: If you want to add more than one category, there's no need to open several tickets. Submit one ticket with the names of the categories, in alphabetical order, and add to the Additional information or request field that you want to add all categories and, if necessary, include more details. The ticket title can either be the name of one of the categories or of the overall initiative.
5. Please wait for the request to be processed
- The request for a category should be done only once. From the moment the category is added to the dataset, it will be processed monthly.
- The Culture and Heritage team will respond to the request as quickly as possible and add the category to the dataset.
- N.B.: the dataset is updated once every 30 days, always at the end of the month. To learn the metrics for your category for the current month, please, add your request until the 20th of the month. Otherwise, the category will be added to the following month's request list. It's not possible to have retroactive calculations by default.
Access the data
[edit]After the category is added, you can access the data via:
Step by step of renaming or removing categories
[edit]It is possible to request modifications after the category is added to the dataset. You can rename or remove existing categories.
Removing categories
- To remove a category, submit a request using this pre-filled form on Phabricator.
- The request for removing categories follows the same rules of adding a category to the dataset (above): every 30 days, always at the end of the month. Please, submit your request until the 20th of the month.
- The metrics for the category will be available until the end of the month the removal was requested.
Renaming categories
- To rename a category, submit a request using this pre-filled form on Phabricator.
- The request for renaming categories follows the same rules of adding a category to the dataset (above): every 30 days, always at the end of the month. Please, sumbit your request until the 20th of the month.
- Other important considerations:
- In the case of categories that are renamed, the metrics will refresh and the data will be available after the date of the modification.
- Once renamed, the old data will still be associated with the old category name.
- If you rename an allow-listed category, the Commons Impact Metrics dataset will stop showing metrics for that category, unless you submit an allow-list rename request immediately after the actual category rename.
To know the categories currently available and being tracked on the Commons Impact Metrics allow-list check GitLab.
To learn more about the project that created the current Commons Impact Metrics system and its rationale, access this page on Wikitech. Access its data model on this page.